mkutarna commited on
Commit
0402eb9
·
1 Parent(s): 50d21df

Updated README

Browse files

Former-commit-id: a32aa11a8485eefa22084db32ad07dae8adc35fb [formerly 63e07abf3020f24b864e20e0f85b960f6aa8cb6c]
Former-commit-id: e3e2f8dda22fb132bd36058307353d8e952d6a25

Files changed (1) hide show
  1. README.md +22 -21
README.md CHANGED
@@ -1,27 +1,28 @@
1
- Audiobook Gen
2
- =============
3
 
4
- ## Description
5
- Audiobook Gen is a tool that allows the users to generate an audio file of text (e.g. audiobook), read in the voice of the user's choice. This tool is based on the Silero text-to-speech toolkit and uses Streamlit to deliver the application.
6
 
7
- ## Demo
8
- A demonstration of this tool is hosted at HuggingFace Spaces - see [Audiobook_Gen](https://huggingface.co/spaces/mkutarna/audiobook_gen).
 
 
 
 
 
 
9
 
10
- ![Demo Screenshot](https://github.com/mkutarna/audiobook_gen/blob/appdev/resources/audiobook_gen.png "Screenshot")
 
 
 
11
 
12
- #### Instructions
13
- 1. Upload the book file to be converted.
14
- 2. Select the desired voice for the audiobook.
15
- 3. Click to run!
16
 
17
- ## Dependencies
18
- - silero
19
- - streamlit
20
- - ebooklib
21
- - PyPDF2
22
- - bs4
23
- - nltk
24
- - stqdm
25
 
26
- ## License
27
- See [LICENSE](https://github.com/mkutarna/audiobook_gen/blob/master/LICENSE)
 
 
 
 
1
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/mkutarna/audiobook_gen/blob/master/LICENSE)
2
+ ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/mkutarna/audiobook_gen/Python%20application)
3
 
4
+ # Audiobook Gen
 
5
 
6
+ ## About
7
+ Audiobook Gen converts text to audiobook format. It allows you to choose which voice you want to listen to.
8
+
9
+ - Do you want to listen to a book that isn't available on Audible?
10
+ - Have you tried an audiobook from LibriVox and found the audio quality lacking?
11
+ - Don't have time to sit and read a document, but would prefer to listen to it?
12
+
13
+ You can input various text formats (`txt`, `pdf`, `epub` - more options in development) and output a `zip` archive of audio files (`wav`). This is an open-source tool based on the [Silero text-to-speech toolkit](https://github.com/snakers4/silero-models) and uses Streamlit to deliver the application.
14
 
15
+ # Demo
16
+
17
+ ## HuggingFace Space
18
+ A demonstration of this tool is hosted at HuggingFace Spaces - see [Audiobook_Gen](https://huggingface.co/spaces/mkutarna/audiobook_gen).
19
 
20
+ [<img style="border:1px solid grey" src="resources/audiobook_gen.png" alt="Screenshot"/>](https://huggingface.co/spaces/mkutarna/audiobook_gen)
 
 
 
21
 
22
+ # Future
 
 
 
 
 
 
 
23
 
24
+ Here is a list features in development and planned for the future:
25
+ - `html` file import
26
+ - `mobi`, `azw` audiobook output
27
+ - improved audio file output handling
28
+ - Docker image for local use