Skip to content

Commit

Permalink
Merge pull request #12 from Vishesh-dd4723/hsv_color
Browse files Browse the repository at this point in the history
Code Reformat and OOPs added
  • Loading branch information
PK-cod3ch3mist authored Oct 7, 2022
2 parents 591774e + fa47f57 commit 0201fb9
Show file tree
Hide file tree
Showing 3 changed files with 184 additions and 227 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Contribution guidelines

Thank you for showing your interest in the repository and the idea. I am grateful to be working with fellow developers.

## Raising Issues
*Issues may be raised only upon problems raised while using the main and tc-version branches.*

Note that alpha branch code is highly unstable and is expected to break, kindly do not raise issues regarding it.
When raising an issue, try your best to include the following information:

- Which branch were you using when things broke?
- What was your input?
- What was the throwback/error message received, if any?
Expand All @@ -16,6 +16,7 @@ When raising an issue, try your best to include the following information:
If some infromation is not available to you, you should mention that too.

## Responding to issues

*When contributing, you can contribute to any branch.
The issues page will give you a list of issues you can resolve in the main branch.*

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
A python program that creates ASCII graphics from images and videos. It can also play videos with subtitle support (given a .srt file)! :scream:

# 🍎 Motivation

You have seen Music Players, Stackoverflow surfers, Hacker News portals etc. in the terminal, so it is the logical next step 😅. Besides, the terminal makes almost everything appear x10 times more cool.

# ⚗️ Dependencies

## Language and Packages

The program runs using python3
The following python packages are used in the program:

- pysrt
- opencv-python
- Pillow
Expand All @@ -26,6 +29,7 @@ All POSIX compliant terminals should work well. If you use windows, and the prog
https://user-images.githubusercontent.com/55488899/161427699-1d606858-4a3d-4490-b21e-ecd4ac56a83b.mp4

# 🛠️ Usage

Navigate to the directory of the python script and run the following command
```shell
python generate.py $VIDEO_FILENAME $SUBTITLE_FILENAME $OPTION
Expand All @@ -37,6 +41,7 @@ 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

- [x] Support 3-bit RGB (8-colors)
- [x] Support true color (24-bit RGB) *visit tc-version branch*
- [ ] Support automatic resizing
Expand Down
Loading

0 comments on commit 0201fb9

Please sign in to comment.