sloum
/
pbmview
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adds readme text

This commit is contained in:
sloum 2021-04-20 23:05:03 -07:00
parent 7824ff344f
commit eb17eb1859
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -2,7 +2,7 @@
pbmview is a program, written in golang, to display [netpbm](https://en.wikipedia.org/wiki/Netpbm) images in a terminal. This likely exists as a part of the very large netpbm package many operating systems/distros make available in their repositories... but it was fun to work on.
At present pbmview supports: P1, P2, and P3 images (all of the human readable ASCII file types). Support may get added at a later point for types > P3 (binary types).
At present pbmview supports: P1, P2, and P3 images (all of the human readable ASCII file types). Support may get added at a later point for types > P3 (binary types). The ascii types are fun to use to create little icons that can be used in shell scripts or the like. The fact that they are human readable make them a cool format for sharing over gopher/gemini as plain text. This formatting, being ascii based, will result in a larger image size than a jpg/png/etc in most cases, so if you decide to use it I recommend doing so for its ease of programming/scripting and for its ease of human readability.
## Build and Use
@ -18,3 +18,5 @@ The available flags are:
- `-scale [chars]` - Will scale the image to a width equal to _chars_, where _chars_ represents a pixel width in terminal characters.
- `-h` - Print help text and exit
Examples netpbm images are provided in the examples folder (which contains its own readme for attribution purposes).