nick/photojawn
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README with changes

Browse source
This commit is contained in:
Nick Pegg 2025-05-08 08:53:03 -07:00
parent ed31a6724a
commit b85ea1b420
1 changed files with 17 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,9 +1,8 @@
# photojawn # photojawn
This is a super-simple photo album static site generator. You feed it a This is a super-simple photo album static site generator. You feed it a directory of photos (which
directory of photos (which can contain directories of photos, etc. etc.) and can contain directories of photos, etc. etc.) and it'll generate a basic HTML photo album for you.
it'll generate a basic HTML photo album for you. You can then host the You can then host the directory with a webserver of your choice or upload it to an S3 bucket.
directory with a webserver of your choice or upload it to an S3 bucket.
It's everything I need and nothing I don't. 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 ### 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 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) 2. Download the binary for your OS/arch
a. To install, run `pip install photojawn-<version>-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`.
### Initialization ### Initialization
@ -28,14 +21,13 @@ Then inside your photo directory, run:
photojawn init photojawn init
``` ```
This will create a config file, some [jinja2](https://jinja.palletsprojects.com/en/latest/templates/) This will create a config file, some [Tera](https://keats.github.io/tera/docs/#templates) (similar
HTML templates, and a CSS file. Edit them to your heart's content to make your to Jinja) HTML templates, and a CSS file. Edit them to your heart's content to make your photo
photo album website purdy. album website purdy.
### Generating the site ### Generating the site
To generate the HTML files and various image sizes, inside your photo To generate the HTML files and various image sizes, inside your photo directory, run:
directory, run:
``` ```
photojawn generate photojawn generate
``` ```
@ -43,17 +35,18 @@ photojawn generate
## Special features ## 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 - 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 images, its contents will be used as the album description. `.md` files will be rendered as
be rendered as Markdown. Markdown.
- If an image file (e.g. `IMG_1234.jpg`) has a corresponding `.txt` or `.md` - 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` file (e.g. `IMG_1234.md`) then it'll be used as the image's caption. `.md` files will be
files will be rendered as Markdown. rendered as Markdown.
- If you have an image in a directory called `cover.jpg` (or a symlink - 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 to another image named that), then it'll be used as the cover image for the album. If one
album. If one doesn't exist, the first image in the directory will be used as doesn't exist, the first image in the directory will be used as the cover image. If a directory
the cover image. has no images itself, it'll use the first sub-directory's cover as its cover image
## y tho ## y tho