Spruce up readme
This commit is contained in:
parent
52c1a47a91
commit
ef1814409d
2 changed files with 59 additions and 5 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,6 +1,7 @@
|
|||
# Python stuff
|
||||
__pycache__
|
||||
.testmondata
|
||||
dist
|
||||
|
||||
# Project specific files
|
||||
test_album
|
||||
|
|
63
README.md
63
README.md
|
@ -1,11 +1,64 @@
|
|||
# photojawn
|
||||
|
||||
A super simple photo album static site generator. You give it a path to a folder of
|
||||
photos and other photos, and it'll generate a basic photo album in that directory. Then
|
||||
you can upload that directory to a webserver of your choice (like an AWS S3 bucket) to
|
||||
host it.
|
||||
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.
|
||||
|
||||
Heavily inspired by the photo albums found on https://bayarearides.com
|
||||
|
||||
## Getting Started
|
||||
|
||||
TODO: Installation instructions lol
|
||||
|
||||
### Initialization
|
||||
|
||||
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.
|
||||
|
||||
### Generating the site
|
||||
|
||||
To generate the HTML files and various image sizes, inside your photo
|
||||
directory, run:
|
||||
```
|
||||
photojawn generate
|
||||
```
|
||||
|
||||
|
||||
## Special features
|
||||
|
||||
- HTML templates are written using [jinja2](https://jinja.palletsprojects.com/en/latest/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.
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
|
||||
## y tho
|
||||
|
||||
Why create a new photo album doohickey? Why not use one of the untold number of
|
||||
cloud services or even self-hosted solutions? It boils down to a few things:
|
||||
|
||||
1. I want control of my data. I don't want some company using my pictures to
|
||||
train their AI models, for example.
|
||||
2. A lot of the self-hosted solutions (Immich, PhotoPrism, etc.) don't support
|
||||
nested albums
|
||||
3. I love simplicity. I'm following the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy)
|
||||
here: "do one thing, do it well" and make use of composable tools to get the
|
||||
job done.
|
||||
|
||||
I took heavy inspiration by the photo albums found on https://bayarearides.com
|
||||
([example](https://bayarearides.com/rides/annadel1/photos/)).
|
||||
|
|
Loading…
Add table
Reference in a new issue