recreate readme
This commit is contained in:
44
README.md
44
README.md
@ -1,20 +1,38 @@
|
||||
# PhotoHUB
|
||||
Just a simple python program to generate static site
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Picture Page
|
||||

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

|
||||
|
||||
## Installation
|
||||
``` sh
|
||||
python3 -m venv venv
|
||||
python3 -m pip -r requirements.txt
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Move and rename file
|
||||
```sh
|
||||
python3 tools/copy.py %your raws% %site location%
|
||||
```
|
||||
|
||||
Generate html page
|
||||
``` sh
|
||||
python3 src/main.py %site location%
|
||||
```
|
||||
|
||||
## File
|
||||
|
||||
- RAW: (optionnal)
|
||||
- EDIT_DATA: (optionnal)
|
||||
- LARGE: high resolution format (optionnal: can be generated by the RAW)
|
||||
- SMALL: low resolution format (optionnal: can be generated by the LARGE)
|
||||
- DESQ: description markdown file (optionnal)
|
||||
### Mandatory
|
||||
- a .png
|
||||
|
||||
### Format supported
|
||||
```
|
||||
RAW: .NEF
|
||||
LARGE: .png
|
||||
SMALL: jpeg
|
||||
EDIT_DATA: .pp3
|
||||
DESQ: .md
|
||||
```
|
||||
### Optionnal
|
||||
- raw {*.NEF}
|
||||
- readme.md
|
||||
- (png file).out.pp3
|
Reference in New Issue
Block a user