Skip to content
This repository was archived by the owner on Aug 2, 2026. It is now read-only.

Commit 67beb73

Browse files
authored
Update README.md
Added reference to manual pages and more details
1 parent a99172e commit 67beb73

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,32 @@
1818

1919
`lib2opds` is distributed on PyPI. The best way to install it is with [pipx](https://pipx.pypa.io).
2020

21-
```
22-
pipx install lib2opds
21+
```shell
22+
$ pipx install lib2opds
2323
```
2424

2525
## How to use
2626

27+
Please read the manual frist:
28+
```shell
29+
$ man lib2opds
2730
```
31+
Let's consider the following library directory:
32+
```shell
2833
$ tree ./test-library/
2934
./test-library/
3035
├── Linux
3136
│   └── How Linux Works - Brian Ward.epub
3237
└── Science Fiction
3338
├── All Systems Red.epub
3439
└── I, Robot - Isaac Asimov.epub
35-
40+
```
41+
Generate OPDS catalog and complimenting HTML site for the library directory:
42+
```shell
3643
$ lib2opds --opds-base-uri "/opds/" --library-base-uri "/library/" --library-dir "./test-library" --opds-dir "./output" --generate-site-xslt
37-
44+
```
45+
Get the following result:
46+
```shell
3847
$ tree ./output/
3948
./output/
4049

@@ -54,9 +63,9 @@ $ tree ./output/
5463
└── index.xml
5564
```
5665

57-
`/etc/lib2opds.ini` is used by default and options can be overridden via command line arguments.
66+
`/etc/lib2opds.ini` is used by default and options can be overridden via command line arguments. See `$ man 5 lib2opds.ini` for more details.
5867

59-
Example of configuration file for Nginx with HTTP Basic Authentication:
68+
Now it is possible to serve it with any HTTP server. Example of configuration file for Nginx with HTTP Basic Authentication:
6069

6170
```nginx
6271
location /library {

0 commit comments

Comments
 (0)