Skip to content

Commit

Permalink
Added additional context to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mitja Felicijan committed Jul 3, 2023
1 parent 82bc91b commit 9b881c0
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,17 @@ Audio sample: https://github.com/mitjafelicijan/abtts/raw/master/samples/25.mp3

## Install

**Program uses [virtual
environments](https://docs.python.org/3/library/venv.html) so make sure that you
have Python, Pip and virtual environments installed properly.**

```sh
git clone [email protected]:mitjafelicijan/abtts.git
cd abtts

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```

## How to use it
Expand Down Expand Up @@ -53,7 +61,9 @@ Environmental variables can prefix python command like in the example above with
## Create new audiobooks

- Books have a specific filesystem structure. Each book needs to have `toc.txt`
file and cover image in the same directory.
file and cover image in the same directory.
- Each book should have it's own directory to itself. Do not mix and match
multiple books together.
- Books should be split into chapters, but also only one chapter is sufficient.

And example of TOC file.
Expand Down

0 comments on commit 9b881c0

Please sign in to comment.