Skip to content

Commit c6e2444

Browse files
committed
docs: update
1 parent 058cb79 commit c6e2444

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ A feature-rich media-to-ASCII converter written in C++
1414
## Features
1515

1616
- Convert **media files to ASCII art** with **customizable character sets**
17+
- **URL support** for downloading images and videos directly from web URLs
1718
- **Real-time video playback** with smooth frame-by-frame ASCII conversion
1819
- **Auto-fit by default** to terminal size for optimal viewing experience
1920
- Supports **grayscale** and **ANSI-colored** output for all media types
@@ -33,19 +34,21 @@ Ensure you have the following installed:
3334
- **C++17** or later
3435
- **CMake** (>= 3.10)
3536
- **OpenCV** (>= 4.0) for video and GIF support
37+
- **curl** or **wget** for URL download support
3638
- `stb_image.h`, `stb_image_write.h`, and `stb_image_resize2.h` (already included)
3739

3840
#### Installing OpenCV
3941

4042
```bash
4143
# Ubuntu/Debian
42-
sudo apt-get install libopencv-dev
44+
sudo apt-get install libopencv-dev curl
4345

4446
# macOS (with Homebrew)
45-
brew install opencv
47+
brew install opencv curl
4648

4749
# Windows (with vcpkg)
4850
vcpkg install opencv
51+
# curl is usually pre-installed on Windows 10+
4952
```
5053

5154
### Build Instructions
@@ -86,7 +89,7 @@ pixcii --help
8689

8790
| Option | Description |
8891
| ---------------------------- | ------------------------------------------------------------- |
89-
| `-i, --input <path>` | Path to input media file (required) |
92+
| `-i, --input <path¦url>` | Path to input media file or URL (required) |
9093
| `-o, --output <path>` | Path to save output ASCII art (optional) |
9194
| `-c, --color` | Enable colored ASCII output using ANSI escape codes |
9295
| `-g, --original` | Display media at original resolution |
@@ -103,7 +106,8 @@ pixcii --help
103106

104107
**Images:** JPG, PNG, BMP, TGA, GIF (static)
105108
**Videos:** MP4, AVI, MOV, MKV, WEBM, M4V, WMV, FLV
106-
**Animated:** GIF
109+
**Animated:** GIF
110+
**Input Sources:** Local files and web URLs
107111

108112
### Example Commands
109113

@@ -120,6 +124,22 @@ pixcii -i video.mp4 -c
120124
pixcii -i animation.gif -e
121125
```
122126

127+
#### URL Processing
128+
129+
```bash
130+
# Process image from URL
131+
pixcii -i https://example.com/image.jpg -c
132+
133+
# Process video from URL
134+
pixcii -i https://example.com/video.mp4 -e
135+
136+
# URLs without extensions (auto-detects content type)
137+
pixcii -i "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR..." -c
138+
139+
# Download and save ASCII art from URL
140+
pixcii -i https://example.com/photo.png -o downloaded_ascii.txt
141+
```
142+
123143
#### Original Size Mode
124144

125145
```bash
@@ -167,6 +187,7 @@ pixcii -i video.mp4 -m " .:-=+*#%@" -c
167187
- [x] Automatically detect the terminal size and scale the output to fit
168188
- [x] Media support with real-time playback
169189
- [x] Auto-fit by default with original size option
190+
- [x] URL support with smart content-type detection
170191
- [ ] Implement different character sets optimized for different scenarios
171192
- [ ] Allow users to save and load parameter presets via config files
172193
- [ ] Performance optimizations for high-resolution media

0 commit comments

Comments
 (0)