summaryrefslogtreecommitdiff
path: root/README.md
blob: f2c24051c8ea12add8bcf1215bc15f7b14913787 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# photoalbum

photoalbum is a minimal Bash script for Unix like operating systems (such as Linux) to generate static web photo albums.
The resulting static photo album is pure HTML+CSS (without any JavaScript!). An example album can be surfed here: https://sidewalk.ninja

## Installation

Run the following commands to install it:

```
make
sudo make install
```

Also, as a requirement, `convert` from ImageMagick needs to be installed.  

## Usage

```
    photoalbum clean|generate|version [rcfile] photoalbum
    photoalbum makemake
```

* `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.

## 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.
4. Distribute the `./dist` directory to a static web server.
5. Clean the mess up with `make clean` or `photoalbum clean`

## HTML templates

Poke around in this source directory. You will find a bunch of Bash-HTML template files. You could tweak them to your likings.