diff options
| author | Nils <git@velohero.com> | 2016-11-06 12:40:01 +0100 |
|---|---|---|
| committer | Nils <git@velohero.com> | 2016-11-06 12:40:01 +0100 |
| commit | 83560c97b635622897c5c801d3960579bfdf732f (patch) | |
| tree | 92c3934efe6fdde3c23cc86c58f00b8f10012bb4 /README.md | |
| parent | e98190fb33371ff1a206010a94b94604d6435be5 (diff) | |
first commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..95d2042 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +gallery.sh +========== + +Bash Script to generate static web galleries. No server-side programs (i.e. PHP, MySQL) required. + +Overview +-------- +`gallery.sh` is simple bash shell script which generates static html thumbnail (image, photo) galleries using the `convert` and `jhead` command-line utilities. +It requires no special server-side script to run to view image galleries because everything is pre-rendered. +It offers several features: +* Responsive layout +* Thumbnails which fill the browser efficiently +* Download the original image file +* Nice and simple Bootstrap CSS layout +* Locally previewable galleries by accessing images locally (e.g. file:///home/nils/pics/gallery/index.html) +* JPEG header EXIF data extraction +* Auto-rotation of veritcal images + +This combination of features makes a better user experience than pretty much all the big online photo hosts. +All you need is a place to host your plain html and jpeg files. This can also be Amazon S3. + +Requirements +------------ +* ImageMagick (http://www.imagemagick.org/) for the `convert` utility. +* JHead (https://wiki.ubuntuusers.de/JHead/) for EXIF data extraction + +On a debian-based system (Ubuntu), just run `apt-get install imagemagick jhead` as root. + +Under macOS you can install it with MacPort (https://www.macports.org/): `sudo port install imagemagick jhead` + +Usage +----- + + gallery.sh [-t <title>] [-h] + +`gallery.sh` works in the **current** directory. Just load the index.html in a browser see the output. + +The directory should contain a bunch of JPEG (.jpg or .JPG) files. It does not work recursively. +ZIP files (.zip or .ZIP) and movies (.mov or .MOV) are also considered. They appear as a download button in the gallery. + +Screenshots +----------- + + + + + +License +------- +GNU Public License version 3. +Please feel free to fork and modify this on GitHub (https://github.com/Cyclenerd/gallery_shell).
\ No newline at end of file |