diff --git a/README.md b/README.md index fd7d2a1..b4bf2c8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # photojawn -This is a super-simple photo album static site generator. You feed it a -directory of photos (which can contain directories of photos, etc. etc.) and -it'll generate a basic HTML photo album for you. You can then host the -directory with a webserver of your choice or upload it to an S3 bucket. +This is a super-simple photo album static site generator. You feed it a directory of photos (which +can contain directories of photos, etc. etc.) and it'll generate a basic HTML photo album for you. +You can then host the directory with a webserver of your choice or upload it to an S3 bucket. It's everything I need and nothing I don't. @@ -12,14 +11,8 @@ It's everything I need and nothing I don't. ### Installation -Photojawn requires at least Python 3.12. If you don't know what version you -have, you can check by running `python -V`. - 1. Head on over to the [releases](https://github.com/nickpegg/photojawn/releases) page -2. If you have Python >=3.12, you can install using the wheel (`.whl` file) - a. To install, run `pip install photojawn--py3-none-any.whl` -3. If you don't have Python >=3.12, you can download one of the standalone binaries depending on your OS and architecture, e.g. `photojawn-linux-x86_64`. - +2. Download the binary for your OS/arch ### Initialization @@ -28,14 +21,13 @@ Then inside your photo directory, run: photojawn init ``` -This will create a config file, some [jinja2](https://jinja.palletsprojects.com/en/latest/templates/) -HTML templates, and a CSS file. Edit them to your heart's content to make your -photo album website purdy. +This will create a config file, some [Tera](https://keats.github.io/tera/docs/#templates) (similar +to Jinja) HTML templates, and a CSS file. Edit them to your heart's content to make your photo +album website purdy. ### Generating the site -To generate the HTML files and various image sizes, inside your photo -directory, run: +To generate the HTML files and various image sizes, inside your photo directory, run: ``` photojawn generate ``` @@ -43,17 +35,18 @@ photojawn generate ## Special features -- HTML templates are written using [jinja2](https://jinja.palletsprojects.com/en/latest/templates/) +- HTML templates are written using [Tera](https://keats.github.io/tera/docs/#templates), which is + very similar to [Jinja](https://jinja.palletsprojects.com/en/stable/templates/) - If you have a `description.txt` or `description.md` file in a directory with - images, its contents will be used as the album description. `.md` files will - be rendered as Markdown. + images, its contents will be used as the album description. `.md` files will be rendered as + Markdown. - If an image file (e.g. `IMG_1234.jpg`) has a corresponding `.txt` or `.md` - file (e.g. `IMG_1234.md`) then it'll be used as the image's caption. `.md` - files will be rendered as Markdown. + file (e.g. `IMG_1234.md`) then it'll be used as the image's caption. `.md` files will be + rendered as Markdown. - If you have an image in a directory called `cover.jpg` (or a symlink - to another image named that), then it'll be used as the cover image for the - album. If one doesn't exist, the first image in the directory will be used as - the cover image. + to another image named that), then it'll be used as the cover image for the album. If one + doesn't exist, the first image in the directory will be used as the cover image. If a directory + has no images itself, it'll use the first sub-directory's cover as its cover image ## y tho