summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dfde148
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+```
+ ▄▄ • ▄• ▄▌ ▐ ▄ .▄▄ · ▄▄▄▄▄ ▄▄▄· ▄▄· ▄ •▄
+▐█ ▀ ▪█▪██▌•█▌▐█▐█ ▀. •██ ▐█ ▀█ ▐█ ▌▪█▌▄▌▪
+▄█ ▀█▄█▌▐█▌▐█▐▐▌▄▀▀▀█▄ ▐█.▪▄█▀▀█ ██ ▄▄▐▀▀▄·
+▐█▄▪▐█▐█▄█▌██▐█▌▐█▄▪▐█ ▐█▌·▐█ ▪▐▌▐███▌▐█.█▌
+·▀▀▀▀ ▀▀▀ ▀▀ █▪ ▀▀▀▀ ▀▀▀ ▀ ▀ ·▀▀▀ ·▀ ▀
+```
+
+Collection of modular and minimal libraries used by our games. These libraries are designed to be
+"vendored in" aka. copy-and-pasted into a project's folder. Some libraries may depend on each other.
+Each library should contain a license in the header.
+
+Use at your own risk.
+
+| Name | Description |
+| ------ | ------------------------------------------ |
+| Podium | Platform layer & kitchen sink. |
+| Peak | Automagic cross-platform dark magic. |
+| Poof | Build software without going insane. |
+| Rend | Modern graphics API layer. |
+| Cool | Render HTML by calling functions. |
+
+## Maturity
+
+Rend and Podium are the most mature. Some libraries are still in development. Check the version
+included in each header file. Be encouraged and not discouraged if a library "isn't updated," it's probably
+because it works.
+
+## Documentation
+
+Documentation can be found on [godgun.net](https://godgun.net/docs) (results may vary).
+We recommend just reading the header files. It's all there.