summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e981b0a
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+autistdraw
+==========
+
+`autistdraw' will be a terminal drawing application with multiplayer support.
+
+Building and Running
+--------------------
+Build dependencies: GCC/Clang, pkg-config, GNU make, Jansson, cURL, readline
+
+If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work
+just as good. But there's no CMake support yet, so I force it in the Makefile.
+
+ $ git clone https://github.com/pjanouch/autistdraw.git
+ $ git submodule init
+ $ git submodule update
+ $ mkdir build
+ $ cmake .. -DCMAKE_BUILD_TYPE=Debug
+ $ make
+ $ ./autistdraw
+
+License
+-------
+`autistdraw' is written by Přemysl Janouch <p.janouch@gmail.com>.
+
+You may use the software under the terms of the ISC license, the text of which
+is included within the package, or, at your option, you may relicense the work
+under the MIT or the Modified BSD License, as listed at the following site:
+
+http://www.gnu.org/licenses/license-list.html