summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDanny Holman <dholman@gymli.org>2024-08-30 01:41:09 -0500
committerDanny Holman <dholman@gymli.org>2024-08-30 01:41:09 -0500
commit1064864b5112653e0038adeca05ae6db090bf587 (patch)
treeb62abe7c9ed92323aff081d70e07d08a1330477e /README.md
parent1ce6031a42d22a0f2be566e1873377ab2cda66c8 (diff)
Add README file
Add a README file to the project root. This file will act as the introduction point for the entire project. Signed-off-by: Danny Holman <dholman@gymli.org>
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..621e415
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Rune Game Engine
+
+Rune is an open source (ZLib license), fully 3D game engine written in pure C.
+The engine is designed to give the programmer as much flexibility as possible in
+project layout, as the engine is designed to be just another system library.
+
+## Contributing
+
+Rune is hosted at https://www.gymli.org/ and all development is done on the
+[mailing list](https://lists.gymli.org/rune-engine). The project loosely follows
+the development model of the Linux kernel and other similar projects. Volunteers
+who wish to contribute should see the relevant documentation in the `doc`
+directory and submit patches via email, rather than attempt to perform
+Github-style pull requests.
+
+## Copyright
+
+* Copyright (C) 2024 Danny Holman <dholman@gymli.org>