added readme and license

[vrlugburz] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..c426b53
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+Lugburz VR
+==========
+This is a VR grid-based first person dungeon crawler project, for the VR
+dungeon crawler game jam: https://itch.io/jam/dungeon-crawler-vr-game-jam-2021
+
+Not done yet...
+
+License
+-------
+Copyright (C) 2021 John Tsiombikas <nuclear@member.fsf.org>
+
+This program is free software. Feel free to use, modify and/or redistribute,
+under the terms of the GNU General Public License v3, or at your option any
+later version published by the Free Software Foundation. See COPYING for
+details.
+
+Datafiles
+---------
+ - checkout `svn://mutantstargoat.com/datadirs/vrlugburz` as `datasrc`
+ - run `tools/mkdata` to process/copy data files to `data/`