Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrglm authored Sep 16, 2024
1 parent 0dc25fe commit 97d4405
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,48 @@
$ pip install pdfkit bs4
```

## USAGE
## TYPICAL USAGE
```
$ python librero.py && python set.py && python exlibris.py
```
1st: Generate library.html / Library-set.html / exlibris.html
2nd: Visualize them on a browser.


### Generate HTML libraries:
```
$ python librero.py
$ python set.py
$ python librero.py # Generates and/or ./library.html
$ python set.py # Generates and/or updates ./Library-set.html
```
### Create an Exlibris PDF list:
```
$ python pdf.py
$ python pdf.py # Generates a PDF with all exlibris data
```
### Create an Exlibris :
```
$ python exlibris.py # Generates and/or updates ./exlibris.html
```

### Edit the JSON:
```
$ python JSON_editor.py
$ python editor_JSON.py # Can edit every JSON line / data
```
### Edit the JSON via HTML interface:
```
$ open ./editor.html
$ open ./editor.html # An HTML JSON editor.
```

## Files generated:

1. ./library.html - Basic exlibris list.
2. ./Library-set.html - Advanced exlibris management.
3. ./Library.pdf - PDF with a full data output.

4. ./exlibris.html - SVG/PNG Editor, Exlibris logo creator app.

5. ./library.json - A JSON list with all your exlibris data.
6. ./files/* - Every book cover.


_(Development in progress)_


Expand Down

0 comments on commit 97d4405

Please sign in to comment.