Skip to content

Commit f145738

Browse files
Update README.md
1 parent 55bb563 commit f145738

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,45 @@
11
# PDF AUDIO READER
22

3-
A **simple** and **offline** PDF audio reader using:
3+
A **simple** and **offline** PDF audio reader using Python.
4+
5+
6+
## How it works?
7+
8+
The task can be simply divided into 2 steps:
9+
10+
1. Extract text from PDF. Refer [read.py](https://github.com/nikhilkumarsingh/PDF_AUDIO_READER/blob/master/read.py) for a sample.
11+
12+
2. Convert text to speech. Refer [speak.py](https://github.com/nikhilkumarsingh/PDF_AUDIO_READER/blob/master/speak.py) for a sample.
13+
14+
[pdf_audio_reader.py](https://github.com/nikhilkumarsingh/PDF_AUDIO_READER/blob/master/pdf_audio_reader.py) contains the complete code.
15+
16+
17+
## Dependencies
418

519
- [PyPDF2](https://github.com/mstamy2/PyPDF2)
620

7-
- [pyttsx3](https://github.com/nateshmbhat/pyttsx3)
21+
```
22+
pip install PyPDF2
23+
```
24+
25+
- [pyttsx3](https://github.com/nateshmbhat/pyttsx3)
26+
27+
```
28+
pip install pyttsx3
29+
```
30+
31+
32+
## TODOs
33+
- [ ] Suggest a cool name for this project.
34+
35+
- [ ] Create a requirements.txt file.
36+
37+
- [ ] A CLI for the PDF audio reader program.
38+
39+
- [ ] Create a Python package for this project.
40+
41+
42+
## Video link:
43+
[<img src=https://i.ytimg.com/vi/J-o99pzbBJk/sddefault.jpg height=400 width=350>](https://www.youtube.com/watch?v=J-o99pzbBJk)
44+
45+
[Indian Pythonista](https://youtube.com/IndianPythonista)

0 commit comments

Comments
 (0)