aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-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)
href='#n113'>113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143