From 4b4459cfbb5123d2e051b0cf271647f029ff7994 Mon Sep 17 00:00:00 2001
From: Starnakin <camille@chauvet.pro>
Date: Tue, 8 Jul 2025 03:05:40 +0200
Subject: [PATCH] add: update readme

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 52 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 0a4c7b3..a80afa6 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,10 @@ Just a simple python program to generate static site
 
 ## Screenshots
 
-### Picture Page
+### Bulk Page
 ![](./screenshots/page.png)
 
-### Album Page
+### Bulk Album Page
 ![](./screenshots/album.png)
 
 ## 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
\ No newline at end of file
+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
\ No newline at end of file