docs: more wording & ordering
This commit is contained in:
parent
bd7ee15e54
commit
19b2cd05de
56
README.md
56
README.md
@ -128,33 +128,6 @@ You'll need [Go] >= 1.11 installed. Run `make` to build a new `./distribusi` exe
|
|||||||
|
|
||||||
If you wanna learn Go, I've got [this book], feel free to take a loan of it :grinning:
|
If you wanna learn Go, I've got [this book], feel free to take a loan of it :grinning:
|
||||||
|
|
||||||
## Release
|
|
||||||
|
|
||||||
Currently, you have to be `@decentral1se` to do this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git tag <version>
|
|
||||||
VERSION=<version> make release
|
|
||||||
```
|
|
||||||
|
|
||||||
You can build a local-only release by running this:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
goreleaser release --snapshot --rm-dist
|
|
||||||
```
|
|
||||||
|
|
||||||
Binaries are in `dist/`.
|
|
||||||
|
|
||||||
## Acknowledgements
|
|
||||||
|
|
||||||
[`AUTHORS.md`](./AUTHORS.md)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
<a href="https://git.vvvvvvaria.org/decentral1se/distribusi-go/src/branch/main/LICENSE">
|
|
||||||
<img src="https://www.gnu.org/graphics/gplv3-or-later.png" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
|
|
||||||
### SSH guide for `-P/--publish`
|
### SSH guide for `-P/--publish`
|
||||||
@ -199,7 +172,7 @@ connection details are used. You can [open a ticket] and we can try and help.
|
|||||||
cat contrib/logo/LOGO | lolcat -F 0.1
|
cat contrib/logo/LOGO | lolcat -F 0.1
|
||||||
```
|
```
|
||||||
|
|
||||||
### Differences compared to the Python version
|
## Differences compared to the Python version
|
||||||
|
|
||||||
- It's simpler to install on your computer, just download the binary, `chmod
|
- It's simpler to install on your computer, just download the binary, `chmod
|
||||||
+x` and run it :tada: There is no need to install [Pillow] for handling
|
+x` and run it :tada: There is no need to install [Pillow] for handling
|
||||||
@ -214,6 +187,33 @@ cat contrib/logo/LOGO | lolcat -F 0.1
|
|||||||
|
|
||||||
Continue with the [install instructions].
|
Continue with the [install instructions].
|
||||||
|
|
||||||
|
## Release
|
||||||
|
|
||||||
|
Currently, you have to be `@decentral1se` to do this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git tag <version>
|
||||||
|
VERSION=<version> make release
|
||||||
|
```
|
||||||
|
|
||||||
|
You can build a local-only release by running this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
goreleaser release --snapshot --rm-dist
|
||||||
|
```
|
||||||
|
|
||||||
|
Binaries are in `dist`.
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
[`AUTHORS.md`](./AUTHORS.md)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
<a href="https://git.vvvvvvaria.org/decentral1se/distribusi-go/src/branch/main/LICENSE">
|
||||||
|
<img src="https://www.gnu.org/graphics/gplv3-or-later.png" />
|
||||||
|
</a>
|
||||||
|
|
||||||
[Go]: https://go.dev
|
[Go]: https://go.dev
|
||||||
[Pillow]: https://pillow.readthedocs.io/en/stable/installation.html#external-libraries
|
[Pillow]: https://pillow.readthedocs.io/en/stable/installation.html#external-libraries
|
||||||
[distribusi]: https://git.vvvvvvaria.org/varia/distribusi
|
[distribusi]: https://git.vvvvvvaria.org/varia/distribusi
|
||||||
|
Loading…
x
Reference in New Issue
Block a user