Skip to content

Commit 493814e

Browse files
committed
Updating readme for v0.1.0 release
1 parent a9874e7 commit 493814e

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,40 @@ If you're looking for an all in one that will send the text to Azure TTS and Ope
1818
Chapter Titles are currently matched with the Table of Contents, if a match does not exist then the internal (to the epub) is used. This works ok, more work here is needed.
1919

2020
## Installation
21-
Until I setup CI, you will need to build this from source.
2221

22+
### Ubuntu (and other Debian based Linux distributions)
23+
1. Grab the latest [release](https://github.com/haydonryan/epub2audiobook/releases)
24+
25+
2. Install the binary
26+
``` bash
27+
sudo dpkg -i ebook2audiobook_0.1.0-1_amd64.deb
28+
```
29+
30+
### Installation from Source.
31+
Requires the rust toolchain (cargo + rustc)
2332
``` bash
2433
git clone https://github.com/haydonryan/epub2audiobook.git
2534
cd epub2audiobook
26-
cargo build
35+
```
2736

37+
Development is currently done in main, you probably want to check out a specific release.
38+
``` bash
39+
git checkout v0.1.0
2840
```
41+
Build and install the binary.
42+
``` bash
43+
cargo install --path .
44+
```
45+
46+
2947
## Converting Books (Usage)
3048
You will need [PiperTTS](https://github.com/rhasspy/piper) and [FFmpeg](https://www.ffmpeg.org/) installed.
3149

3250
After converting a decent amount of books to audiobooks, I found there are really a few steps / checkpoints.
3351
1. Initial Conversion from EPUB -> Text
3452

35-
36-
``` bash
37-
cargo run <epub-filename.epub> <output directory>
53+
``` bash
54+
ebook2audiobook <epub-filename.epub> <output directory>
3855

3956
```
4057
2. Find and replace text.

0 commit comments

Comments
 (0)