Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
linux support
  • Loading branch information
AndyDevla authored Feb 11, 2024
1 parent 5a12a36 commit e098b82
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ A simple, lighest and real serverless web album viewer to display all the images
- Some minor tweaks available.

## Pre-requesites
For now only works on a Windows environment cause use a batch file to parse all the file's name in a JS file, support for Linux will be available later.
Any Windows or Linux environment capable of executing a .bat/.sh file that parses all file names into a JS file.

## How to use
- 1. Simply dowload or clone the repo locally.
- 2. Place all the image files inside the "album" folder.
- 3. Execute "run.bat" to create a script list files.
- 1. Just dowload or clone the repo locally.
- 2. In the "album" folder place all the image files.
- 3. Execute "run.sh" on a Linux system or "run.bat" on a Windows system to create the file's list.
- 4. Open "index.html".

## Some recommendations
- Images may not have spaces on their file names.
- To avoid display issues use type files compatible with modern web browsers.
- If your album contains a big amount of images, you will need plenty amount of RAM.

0 comments on commit e098b82

Please sign in to comment.