Skip to content

Commit 169b9e6

Browse files
committed
refactored readme
1 parent 8dc0667 commit 169b9e6

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,6 @@
22

33
A Rust command line tool that plays videos as _coloured_ ASCII art directly in your terminal with minimal performance overhead.
44

5-
## Steps to run
6-
7-
- If not already, install Rust [via rustup](https://rustup.rs) and FFmpeg (ffmpeg must be on your system PATH).
8-
- Put a video file somewhere on your machine (e.g., videos/sample.mp4).
9-
- From the project root, run in your terminal:
10-
- Debug: `cargo run -- <path-to-video>`
11-
- Release: `cargo run --release -- <path-to-video>`
12-
- Use Ctrl+C to stop playback at any time.
13-
145
## Screenshots
156

167
![sync_test.png](img/sync_test.png)
@@ -21,9 +12,22 @@ And everyone's favourite:
2112

2213
![bad_apple.png](img/bad_apple.png)
2314

15+
## Steps to run
16+
17+
- If not already, install Rust [via rustup](https://rustup.rs) and FFmpeg (ffmpeg must be on your system PATH).
18+
- Put a video file somewhere on your machine (e.g., videos/sample.mp4).
19+
- From the project root, run in your terminal:
20+
- Debug: `cargo run -- <path-to-video>`
21+
- Release: `cargo run --release -- <path-to-video>`
22+
- Use Ctrl+C to stop playback at any time.
23+
2424
## Notes
2525

2626
- Larger terminals look better; a minimum of `30 columns x 20 rows` is recommended.
2727
- Tested on Windows Terminal (Powershell): Achieved ~30fps with `305 columns x 109 rows` (from a 1080p/30fps video) running on a 3.6GHz CPU.
2828
- A cache file is created to speed up subsequent runs of the same video.
2929
- Add --regenerate to force rebuilding the ASCII cache for that video.
30+
31+
## Dependencies
32+
33+
Check ![Cargo.toml](./Cargo.toml) for a full list of dependencies.

0 commit comments

Comments
 (0)