Skip to content

Commit d183c19

Browse files
authored
Update README.md
1 parent 0dcc8c2 commit d183c19

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Zunge is a text documents to audio converter with interactive reader. It uses [f
1212
- Interactive Reader
1313
- Lightweight
1414
- Runs on terminal
15+
- Multiple theme options
1516

1617

1718
## Deployment
@@ -21,11 +22,12 @@ To deploy this project, clone this repository
2122
```bash
2223
git clone https://github.com/havoksahil/zunge
2324
cd zunge
24-
mkdir build
25-
cd build
26-
cmake ..
27-
make
28-
sudo make install
25+
chmod +x install.sh
26+
bash install.sh
27+
28+
# to uninstall zunge
29+
chmod +x uninstall.sh
30+
bash uninstall.sh
2931
```
3032

3133

@@ -40,12 +42,15 @@ zunge -f example.epub -o story.mp3
4042

4143
# start interactive reader
4244
zunge -f example.epub -i
45+
46+
# start interactive reader with speak on with theme active
47+
zunge -f example.pdf -i -s -t 3
4348
```
4449

4550

4651
## Screenshots
4752

48-
![App Screenshot](https://github.com/HavokSahil/Zunge/assets/87008169/e81237f7-c34f-4f2a-a3c1-9eae62be4879)
53+
![App Screenshot](https://github.com/HavokSahil/Zunge/assets/87008169/602fa937-0ab7-4040-b82d-c44324bc20ec)
4954

5055

5156
## Arguments
@@ -57,7 +62,8 @@ zunge -f example.epub -i
5762
| `-f` | `filename`| **Required**. input filename |
5863
| `-o` | `filename` | **Optional**. output filename |
5964
| `-i` | `interactive` | **Optional**. interactive mode |
60-
| `-b` | `bitrate` | **Optional**. bitrate of mp3 compression |
65+
| `-s` | `reader` | **Optional**. read out the text |
66+
| `-t` | `theme` | **Optional**. choose theme |
6167
| `-h` | `filename` | **Optional**. show help |
6268

6369

0 commit comments

Comments
 (0)