decentral1se/distribusi-go
2
1
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

docs: wording pass on README

Browse Source
This commit is contained in:
decentral1se 2022-03-26 11:12:57 +01:00
parent d9342ae910
commit cf8d90f81e
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
1 changed files with 7 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,11 +4,10 @@
<img src="./contrib/logo/logo.png" /> <img src="./contrib/logo/logo.png" />
</p> </p>
> This is still very experimental, please take a backup of your archives if you > This is still quite experimental! Please take a backup of your archives if
> are running it on files you care about. It hasn't been tested on large > you are running it on files you care about. Please [report issues] as you
> archives. There are probably some pretty bad bugs lurking in there. It may > find them :bug: This means we can improve the tool for everyone :sunflower:
> still thrash files. Please [report issues] as you find them :100: Thanks for > Thanks for testing & happy distribusifying!
> testing!
A [Go] implementation of [distribusi]. A [Go] implementation of [distribusi].
@ -24,7 +23,7 @@ If you're coming from the Python version, [here are the differences].
> Current release: **0.1.1-alpha** :rocket: > Current release: **0.1.1-alpha** :rocket:
:champagne: `distribusi-go` has enterprise cross-platform support! :champagne: :champagne: `distribusi-go` has Enterprise :tm: cross-platform support! :champagne:
If your platform isn't listed below, please see [the entire listing]. If you If your platform isn't listed below, please see [the entire listing]. If you
can't find it there, we can probably add support for it (see `$GOOS`/`$GOARCH` can't find it there, we can probably add support for it (see `$GOOS`/`$GOARCH`
@ -208,21 +207,16 @@ 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 :100: There is no need to install [Pillow] for handling +x` and run it :tada: There is no need to install [Pillow] for handling
images, that is now built-in. The only external dependency is [exiftool] for images, that is now built-in. The only external dependency is [exiftool] for
image captions from embedded metadata. If you don't have `exiftool` image captions from embedded metadata. If you don't have `exiftool`
installed, then it gracefully skips that feature. So, you don't need to installed, then it gracefully skips that feature.
install anything else to run `distribusi` now :pray:
- The command-line interface is quite different. There are less optional flags - The command-line interface is quite different. There are less optional flags
and more defaults. I shuffled a number of things around according to my and more defaults. I shuffled a number of things around according to my
preferences (open to changes, please [open a ticket]). For example, I always preferences (open to changes, please [open a ticket]). For example, I always
like my images to be thumbnail'd. like my images to be thumbnail'd.
- There's a handy web server now, just run with `-s`. You can also publish
directly from the command-line using `-P` :metal: It's all built-in, there is
no need to install any additional software.
Continue with the [install instructions]. Continue with the [install instructions].
[Go]: https://go.dev [Go]: https://go.dev