diff options
| author | Paul Buetow <paul@buetow.org> | 2022-02-21 22:30:15 +0000 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2022-02-21 22:30:15 +0000 |
| commit | 45979c0b508e125616d022e6366ea7c45c3b170c (patch) | |
| tree | eda98aebb2f608c0f0ce3c51a39c6ec5a546a918 | |
| parent | 7dd557388056d383f3f5d410d0d825a887ff87b3 (diff) | |
add installation instructions and HTML templates to the readme
| -rw-r--r-- | README.md | 17 |
1 files changed, 15 insertions, 2 deletions
@@ -1,10 +1,19 @@ # photoalbum photoalbum is a minimal Bash script for Unix like operating systems (such as Linux) to generate static web photo albums. -As a requirement `convert` from ImageMagick needs to be installed. - 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 ``` @@ -24,3 +33,7 @@ The resulting static photo album is pure HTML+CSS (without any JavaScript!). An 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. |