diff --git a/README.md b/README.md index 1874a25..8a665c1 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,22 @@ A [Go] implementation of [distribusi]. -This is a compiled `distribusi` which is simpler to install on your computer, -just download the binary, `chmod +x` and run it. +If you're migrating from the Python version or have experience using it, here are the differences in `distribusi-go`: -There is no need to install [Pillow] for handling images, that is now built-in. -The only external dependency is [exiftool] for image captions from embedded -metadata. If you don't have `exiftool` installed, then it gracefully skips that -feature. So, you don't need to install anything else to run `distribusi` now -:pray: +- This is a compiled `distribusi` which is simpler to install on your computer, + just download the binary, `chmod +x` and run it. -If you're migrating from the Python version, be warned, the command-line -interface is quite different from the Python version. There are less optional -flags and more defaults. I shuffled a number of things around according to my -preferences. For example, I always like my images to be thumbnail'd. There's a -handy web server built-in now, just run with `-s` :metal: +- There is no need to install [Pillow] for handling images, that is now + built-in. The only external dependency is [exiftool] for image captions from + embedded metadata. If you don't have `exiftool` installed, then it gracefully + skips that feature. So, you don't need to install anything else to run + `distribusi` now :pray: + +- 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 + preferences (open to changes, please [open a ticket]). For example, I always + like my images to be thumbnail'd. There's a handy web server built-in now, + just run with `-s` :metal: ## Install @@ -37,6 +39,14 @@ chmod +x distribusi ./distribusi -p -s ``` +If you want to ignore certain paths, you can use `-i/--ignore`: + +``` +./distribusi -p -s -i '*.gif' +``` + +If you run into issues, run with `-d/--debug` to see what is happening under the hood. + ## Hacking You'll need [Go] >= 1.11 installed. Run `go build .` to build a new `./distribusi` executable. @@ -46,3 +56,4 @@ You'll need [Go] >= 1.11 installed. Run `go build .` to build a new `./distribus [Pillow]: https://pillow.readthedocs.io/en/stable/installation.html#external-libraries [exiftool]: https://exiftool.org/ [report issues]: https://git.vvvvvvaria.org/decentral1se/distribusi-go/issues/new/choose +[open a ticket]: https://git.vvvvvvaria.org/decentral1se/distribusi-go/issues/new/choose