Skip to content

Commit 522efa7

Browse files
committed
docs: Updated README.md and new .gif
1 parent f31ae53 commit 522efa7

2 files changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,21 @@
77

88
## 📜 Overview
99

10-
**ASCII Generator** is a Python tool that transforms **images** and **videos** into ASCII art in real time or as static output.
10+
**ASCII Generator** is a modular-oriented Python engine that converts images, videos, and live camera feeds into expressive ASCII art. Use it for real-time terminal previews or export results as text, images, or video.
11+
12+
Designed for flexibility and ease of use, the project provides configurable character sets, color and grayscale modes, adjustable density/contrast, and persistent settings for reproducible output.
1113

1214
<p align="center">
13-
<img src="assets/img/app.png" width="600" alt="ASCII App Preview">
15+
<img src="assets/gif/app.gif" width="600" alt="ASCII App Preview">
1416
<br><br>
1517
<em>Interactive terminal interface with real-time preview</em>
1618
</p>
1719

1820
## 🛠️ Things to fix / improve
1921

20-
- **[*] Fix video speed synchronization issues**: the video FPS detection was causing desync between video playback and ASCII rendering speed.
21-
- **[*] View problems with sizing videos on exporting to file:** only change the aspect ratio, it's recommended the default settings be used for best results. (0.50f)
22-
- [ ] Implement logger for debugging
22+
- **[x] Fix video speed synchronization issues**: the video FPS detection was causing desync between video playback and ASCII rendering speed.
23+
- **[x] View problems with sizing videos on exporting to file:** only change the aspect ratio, it's recommended the default settings be used for best results. (0.50f)
24+
- **[x] Implement logger for debugging**
2325
- [ ] Optimize performance for higher resolutions
2426
- [ ] Add custom character sets and styles
2527

@@ -42,6 +44,7 @@
4244
- Persistent user settings (saved between sessions in `config.json`)
4345
- Clean modular architecture — easy to extend
4446
- Windows-friendly (includes `run.bat` launcher)
47+
- Export ASCII art to **text** files or **images/videos**
4548

4649
## 🚀 Installation
4750

@@ -65,7 +68,7 @@ pip install -r requirements.txt
6568
Launch the application:
6669

6770
```cmd
68-
python src/app.py
71+
python src/main.py
6972
```
7073

7174
Alternatively (**Windows** users):
@@ -82,7 +85,7 @@ Once running you can:
8285

8386
## 📦 Dependencies
8487

85-
Listed in `requirements.txt` </br>
88+
Listed in `requirements.txt`.
8689
Main libraries include:
8790

8891
- `opencv-python` — image/video processing
@@ -108,7 +111,7 @@ We appreciate your contributions and feedback! 🙌
108111

109112
## 📝 License
110113

111-
MFOG is licensed under the MIT License.
114+
ASCII Generator is licensed under the MIT License.
112115
See the [LICENSE](LICENSE) file for more details.
113116

114117
[![License: MIT](https://img.shields.io/badge/License-MIT-blue?style=flat)](LICENSE)

assets/gif/app.gif

4.61 MB
Loading

0 commit comments

Comments
 (0)