aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b0d6461
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Fungi
+
+An art generator/simple life simulator.
+
+Fungi is a tool for me to learn about using some different graphics libraries,
+as well as giving me cool new things to look at. Currently written in C++ using
+SDL2, which should make it easy to build on different systems. I plan
+on creating a ncurses based interface as well as porting to different operating
+systems and using their native GUI API.
+Inspired by [Culture by Charlotte Koch](https://github.com/dressupgeekout/screensavers/tree/master/culture).
+
+# Building
+
+Currently the only dependency is SDL2, which is assumed to be in the normal
+location for Debian/Ubuntu.
+
+```
+git clone https://github.com/mlightning3/fungi.git
+cd fungi
+make
+```
+
+# License & Copyright
+
+GPL v3
+
+Matt Kohls 2018