summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6c9ba6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# discord.c
+
+an alternative client for the discord messaging platform, written in the C programming language.
+
+## requirements
+
+* a POSIX system
+* GNU C library
+* GNU compiler collection
+* GNU Make
+* libcurl 7.17.0 or newer with HTTPS support
+
+## instructions
+
+```
+make
+./discord.c -e email@address.example -p password
+```