Add deps installation instruction to README

pull/87/head
Akhyar Amarullah 8 years ago
parent f81645e67d
commit 56b0fe07f2

@ -1,4 +1,4 @@
##About ## About
Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database. Calibre Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database.
@ -6,7 +6,8 @@ Calibre Web is a web app providing a clean interface for browsing, reading and d
![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png) ![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)
##Features ## Features
- Bootstrap 3 HTML5 interface - Bootstrap 3 HTML5 interface
- User management - User management
- Admin interface - Admin interface
@ -26,9 +27,10 @@ Calibre Web is a web app providing a clean interface for browsing, reading and d
## Quick start ## Quick start
1. Rename `config.ini.example` to `config.ini` and set `DB_ROOT` to the path of the folder where your Calibre library (metadata.db) lives 1. Install required dependencies by executing `pip install -r requirements.txt`
2. Execute the command: `python cps.py` 2. Rename `config.ini.example` to `config.ini` and set `DB_ROOT` to the path of the folder where your Calibre library (metadata.db) lives
3. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog 3. Execute the command: `python cps.py`
4. Point your browser to `http://localhost:8083` or `http://localhost:8083/opds` for the OPDS catalog
**Default admin login:** **Default admin login:**
*Username:* admin *Username:* admin

Loading…
Cancel
Save