aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKevin Lange <kevin.lange@dakko.us>2011-11-30 20:14:33 -0600
committerKevin Lange <kevin.lange@dakko.us>2011-11-30 20:14:33 -0600
commit42b929ae7aedc4ec769dd3ab9421e7f95f168368 (patch)
tree250494bc68e5e06748464b1acfd9948415480544 /README.md
parent6015ccf99b1d0d3e94e026af8853906282d8edb4 (diff)
downloadnyancat-42b929ae7aedc4ec769dd3ab9421e7f95f168368.tar.gz
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 53a0bd0..45a275d 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,19 @@
Nyancat rendered in your terminal.
[![Nyancats](http://i.imgur.com/snCOQl.png)](http://i.imgur.com/snCOQ.png)
+
+## Setup
+
+First build the C application:
+
+ make
+
+You can run the C application standalone. It will prompt you to select a color mode.
+
+ ./nyancat
+
+To run the telnet server, use:
+
+ sudo ./nyancat.py
+
+(The server will only try to start on port 23, so you must be root)