Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PK-cod3ch3mist authored Apr 3, 2022
1 parent 007b352 commit 974c16d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ The following python packages are used in the program:
These packages can be installed using any package manager for python like pip, conda, etc.

## Terminal Requirements
**A true-colour terminal is required to see videos and images in colour.**

Also since the program **uses ANSI escape sequences**, all POSIX compliant terminals should work well. If you use windows, and the program doesn't work well, try switching to WSL (Windows Subsystem for Linux)
All POSIX compliant terminals should work well. If you use windows, and the program doesn't work well, try switching to WSL (Windows Subsystem for Linux)

# 🎥 A Demo

Expand All @@ -38,8 +37,8 @@ python generate.py $VIDEO_FILENAME $OPTION
Here `$VIDEO_FILENAME` and `$SUBTITLE_FILENAME` are the full path to the files and `$OPTION` takes values **0 for black and white output** and **1 for true color output** (see if your terminal supports true color before enabling)

# 📝 TODO and Future Plans
- [ ] Support 3-bit RGB (8-colors) with dithering
- [x] Support true color (24-bit RGB)
- [x] Support automatic resizing
- [x] Support 3-bit RGB (8-colors)
- [x] Support true color (24-bit RGB) *visit tc-version branch*
- [ ] Support automatic resizing
- [x] Support B&W output
- [x] Support subtitles

0 comments on commit 974c16d

Please sign in to comment.