summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-06-02 21:55:19 +0300
committerPaul Buetow <paul@buetow.org>2026-06-02 21:55:19 +0300
commit32abc9059610f14046feb058cb323438210d7694 (patch)
tree76b69561eee1df77a4df81358ed38a3bfe6b78db /README.md
parent11a568246ce71ead880e269f12b2abdd4dd66243 (diff)
ki0: switch photoalbum CLI to long options
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 709682b..50eaa0e 100644
--- a/README.md
+++ b/README.md
@@ -18,22 +18,24 @@ modern `magick` command and falls back to `convert` when needed.
## Usage
```
- photoalbum clean|generate|version [rcfile] photoalbum
- photoalbum makemake
+ photoalbum --generate
+ photoalbum --clean
+ photoalbum --version
+ photoalbum --init
```
-* `clean`: Cleans up the workspace
-* `generate`: Generates the static photo album
-* `version`: Prints out the version
-* `makemake`: Creates a Makefile and photoalbumrc in the current working directory.
+* `--generate`: Generates the static photo album
+* `--clean`: Cleans up the workspace
+* `--version`: Prints out the version
+* `--init`: Creates a `photoalbumrc` in the current working directory
## Example usage
-1. See if /etc/default/photoalbum fits your needs. If not, run `photoalbum makemake`, which will create a `photoalbumrc` file in the current directory.
-2. Adjust the `incoming` path in `photoalbum`. Point to a directory with all the pictures in it.
-3. Run `make` (or `photoalbum generate`) to generate it.
+1. See if `/etc/default/photoalbum` fits your needs. If not, run `photoalbum --init`, which will create a `photoalbumrc` file in the current directory.
+2. Adjust the `INCOMING_DIR` path in `photoalbumrc`. Point it to a directory with all the pictures in it.
+3. Run `photoalbum --generate` to generate it.
4. Distribute the `./dist` directory to a static web server.
-5. Clean the mess up with `make clean` or `photoalbum clean`
+5. Clean the mess up with `photoalbum --clean`
## HTML templates