summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-12-11 17:52:38 +0500
committerilotterytea <iltsu@alright.party>2024-12-11 17:52:38 +0500
commitca4f3b6c7f0a261620e1055145175f506a4ec65b (patch)
treec9367b7347a05ea71c79ebcf3819c3edb4b909f6
parentd5c3260848f9051beb96fb96473a560f51a8ed25 (diff)
upd: readmeHEADmaster
-rw-r--r--README.md21
-rw-r--r--example.gifbin0 -> 1535078 bytes
2 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
diff --git a/example.gif b/example.gif
new file mode 100644
index 0000000..1ba5d7c
--- /dev/null
+++ b/example.gif
Binary files differ