summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjaseg <code@jaseg.net>2014-10-25 16:51:49 +0200
committerjaseg <code@jaseg.net>2014-10-25 16:51:49 +0200
commit61d2ff5d2c91ec8b426f9f1e666a7edd3c13ee33 (patch)
treed006c93e476846136060a89fce1bdf6cf8ff761f /README.md
parent1a7b19cd2474841e6faf84fbb6478778d8f2abdc (diff)
downloadlolcat-61d2ff5d2c91ec8b426f9f1e666a7edd3c13ee33.tar.gz
lolcat-61d2ff5d2c91ec8b426f9f1e666a7edd3c13ee33.tar.bz2
lolcat-61d2ff5d2c91ec8b426f9f1e666a7edd3c13ee33.zip
Added installation instructions and extended the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79a5bdb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# What?
+
+![](https://raw.githubusercontent.com/jaseg/lolcat/master/LOLCat-Rainbow.jpg)
+
+## Screenshot
+
+![](https://raw.githubusercontent.com/jaseg/lolcat/master/screenshot.png)
+
+## Installation
+
+```bash
+$ make && sudo make install
+```
+
+## Why?
+
+```bash
+newton~/d/lolcat <3 dmesg>foo
+newton~/d/lolcat <3 cat foo foo foo foo foo foo >bar
+newton~/d/lolcat <3 cat bar bar bar bar bar bar >foo
+newton~/d/lolcat <3 cat foo foo foo foo foo foo >bar
+newton~/d/lolcat <3 cat bar bar bar bar bar bar >foo
+newton~/d/lolcat <3 ls -lh foo
+-rw-r--r-- 1 jaseg jaseg 578M Oct 25 16:48 foo
+newton~/d/lolcat <3 time upstream/bin/lolcat foo
+13.51user 1.34system 0:15.99elapsed 92%CPU (0avgtext+0avgdata 10864maxresident)k
+0inputs+0outputs (0major+1716minor)pagefaults 0swaps
+newton~/d/lolcat <3 time ./lolcat foo
+0.02user 0.00system 0:00.09elapsed 34%CPU (0avgtext+0avgdata 1936maxresident)k
+0inputs+0outputs (0major+117minor)pagefaults 0swaps
+```
+