From cff50b3a00d170c98780f94d5e256c7f5e052a02 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Mon, 7 Feb 2022 15:11:02 +0100 Subject: [PATCH] docs: add description to header, push diferences below --- README.md | 42 +++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7c939ba..b154c70 100644 --- a/README.md +++ b/README.md @@ -12,22 +12,13 @@ A [Go] implementation of [distribusi]. -If you're migrating from the Python version or have experience using it, here are the differences in `distribusi-go`: +`distribusi` is a content management system for the web that produces static +index pages based on folders in the filesystem. It is inspired by the automatic +index functions featured in several web servers. It works by traversing the +file system and directory hierarchy to automatically list all the files in the +directory and providing them with html classes and tags for easy styling. -- 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 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: +If you're coming from the Python version, [here are the differences](). ## Install @@ -212,6 +203,27 @@ connection details are used. You can [open a ticket] and we can try and help. cat contrib/logo/LOGO | lolcat -F 0.1 ``` +### Differences compared to the Python version + +If you're migrating from the Python version or have experience using it, here +are the differences in `distribusi-go`: + +- 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 + 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 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. + [Go]: https://go.dev [Pillow]: https://pillow.readthedocs.io/en/stable/installation.html#external-libraries [distribusi]: https://git.vvvvvvaria.org/varia/distribusi