aboutsummaryrefslogtreecommitdiff
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..cf18034
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# halley-tool
+
+The [halley] game engine is pretty powerful and neat to work with,
+but has terrible tooling on Linux. It's commands and build system are
+focused around using it in Microsoft's Visual Studio.
+
+[halley]: https://github.com/amzeratul/halley
+
+This project aims to fix this with a new CLI that wraps a lot of the
+nonsensical options of the `halley-cmd` and makes it easier to integrate
+with Linux, namely NixOS.
+
+## License
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version.