summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPreston Pan <preston@nullring.xyz>2023-02-06 10:34:27 -0800
committerPreston Pan <preston@nullring.xyz>2023-02-06 10:34:27 -0800
commitaa78cb58ea2e6114753b74479fe58792b0d38f8e (patch)
tree4f17e0f46426198a72f8f63ab6198c90db26691a /README
parente9f782018030fbd5d1884e75efe73881000a3818 (diff)
add usage
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 20 insertions, 1 deletions
diff --git a/README b/README
index 81a9cea..c1a7668 100644
--- a/README
+++ b/README
@@ -1 +1,20 @@
-Simple snake game. May be networked in the future.
+Snake3
+---------------------------------------
+
+This is a simple snake game written in C. It is written
+without ncurses or curses, and instead relies entirely
+on the termios library.
+
+May be networked in the future.
+
+Install
+---------------------------------------
+
+In the root directory of the repository, run `make` and
+`make install`. There are no dependencies.
+
+License
+---------------------------------------
+
+This program is licensed under the MIT license. See
+`LICENSE` for more information.