Add a simple Readme file

This commit is contained in:
Erik Forkalsrud 2021-03-06 15:50:26 -08:00
parent fe165ca271
commit 9cd0d8fd72
2 changed files with 25 additions and 0 deletions

2
.gitignore vendored
View file

@ -9,3 +9,5 @@ cache.properties
/bin
/target
/.externalToolBuilders
*.iml
/.idea

23
Readme.md Normal file
View file

@ -0,0 +1,23 @@
# Album
## Quickstart
- Open `src/test/java/org/forkalsrud/album/Runner.java` and run the `main` method.
- Visit http://localhost:8080/photo/album/
## Requirements
- ffmpeg
- exiftool (perl-Image-ExifTool)
- mplayer
## Configuration
Create a file: `~/forkalsrud.org/photo.properties` and point the `base` property
to your photo folder:
base=/home/photo
dbdir=/home/resin/web/db
ffmpeg.path=/home/resin/bin/ffmpeg