add: update readme
This commit is contained in:
66
README.md
66
README.md
@ -3,10 +3,10 @@ Just a simple python program to generate static site
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Picture Page
|
||||
### Bulk Page
|
||||

|
||||
|
||||
### Album Page
|
||||
### Bulk Album Page
|
||||

|
||||
|
||||
## Installation
|
||||
@ -17,27 +17,65 @@ python3 -m pip -r requirements.txt
|
||||
|
||||
## Usage
|
||||
|
||||
Move and rename file
|
||||
Move and rename file with
|
||||
```sh
|
||||
python3 tools/copy.py %your raws% %site location%
|
||||
python3 tools/copy.py %your raws% %site location%/bulk/
|
||||
```
|
||||
Here you can edit your pictures.
|
||||
|
||||
Generate html page
|
||||
Then
|
||||
|
||||
Generate html page with
|
||||
``` sh
|
||||
python3 src/main.py %site location%
|
||||
```
|
||||
|
||||
## File
|
||||
|
||||
### Mandatory
|
||||
### File tree
|
||||
|
||||
File before `python src/main.py test_out`
|
||||
```
|
||||
test_out/
|
||||
└── bulk
|
||||
└── 00001
|
||||
├── 00001.NEF
|
||||
├── 00001.png
|
||||
└── 00001.png.out.pp3
|
||||
```
|
||||
### Bulk
|
||||
|
||||
#### Mandatory
|
||||
- a .png
|
||||
|
||||
### Optionnal
|
||||
- raw {*.NEF}
|
||||
- readme.md
|
||||
- (png file).out.pp3
|
||||
#### Optionnal
|
||||
- **raw** {*.NEF}
|
||||
- **readme.md**
|
||||
- (png file)**.out.pp3**: permit viewer to download it
|
||||
|
||||
### Futur update
|
||||
- add gimp profile file
|
||||
- unrepertoried page
|
||||
- add audio file on page
|
||||
File after `python src/main.py test_out`
|
||||
```
|
||||
test_out/
|
||||
├── bulk
|
||||
│ └── 00001
|
||||
│ ├── 00001_categories.txt
|
||||
│ ├── 00001.NEF
|
||||
│ ├── 00001.png
|
||||
│ ├── 00001.png.out.pp3
|
||||
│ ├── 00001_small.jpg
|
||||
│ ├── 00001_thumb.jpg
|
||||
│ ├── page.html
|
||||
│ └── readme.md
|
||||
└── index.html
|
||||
```
|
||||
|
||||
### Can be fill
|
||||
|
||||
#### _categories.txt
|
||||
A file to organize your picture, 1 per line like
|
||||
```
|
||||
cats
|
||||
portraits
|
||||
```
|
||||
#### readme.md**
|
||||
A markdown file in the top of the bulk page
|
Reference in New Issue
Block a user