summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index cb1b7f1..21fc650 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
# hyperspace
-TBA
+A screensaver or demoscene, whatever, that opens you up to a new space, hyperspace.
+Made with [Raylib](https://raylib.com) and the C programming language.
+
+![Example](example.gif)
+
+## Compile from sources
+
+```bash
+mkdir build && cd build
+cmake ..
+make
+```
+
+## Customization
+
++ You can replace the star image by placing the `star.png` file along with the executable.
+
+## License
+
+See [LICENSE](LICENSE). This project is under the WTFPL license. \ No newline at end of file