Added a README and a sample image
This commit is contained in:
parent
c27bf18c5d
commit
7d7383a520
3 changed files with 29 additions and 0 deletions
29
README.md
Normal file
29
README.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
PIXELTERM
|
||||
=========
|
||||
An utility to render pixely images on your terminal!
|
||||
|
||||

|
||||
|
||||
Installation
|
||||
------------
|
||||
Type ```sudo make install```, which will copy pixelterm.py to ```/usr/local/bin/pixelterm```.
|
||||
|
||||
Usage
|
||||
-----
|
||||
```pixelterm FILE```
|
||||
|
||||
Advanced usage
|
||||
--------------
|
||||
Since I wrote this tool to generate graphics for
|
||||
[ponysay](https://github.com/jaseg/ponysay), I included a "speech bubble"
|
||||
feature. To make this tool render speech bubble markers which can later be
|
||||
parsed by ponysay, color the pixels where these should be placed 50%
|
||||
transparent red (#FF00007F) for a backward slash link, 50% blue for a forward
|
||||
slash and a 50% transparent green for the speech bubble. Please note that this
|
||||
tool converts images two pixel rows at once and these "special" color values
|
||||
are only parsed for the upper of the two rows. An example image is included.
|
||||
|
||||
Credits
|
||||
-------
|
||||
That awesome Rainbow Dash is by [starsteppony on deviantart](http://starsteppony.deviantart.com/art/Rainbow-Dash-Salute-263753912)
|
||||
|
||||
BIN
example.png
Normal file
BIN
example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
BIN
rainbow-dash.png
Normal file
BIN
rainbow-dash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 KiB |
Loading…
Add table
Add a link
Reference in a new issue