Add README.md

emilwidlund · Sep 5, 2023 · 49f7e9d · 49f7e9d
1 parent b24ba9f
commit 49f7e9d
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+# Alma
+
+![](static/cover.png)
+
+Alma is an interactive playground for generative graphics. 
+
+It comes with a unique node-based editor for WebGL experiences, and a layer-based renderer which can mix graph layers with raw GLSL-based layers.
+
+Nominated for "Fun Side Project of the Year" at React Open Source Awards 2023.
+
+[Open Playground](https://alma.sh)
+
+![](static/alma.png)
+
+## Packages
+
+Alma is divided up into a bunch of different sub-packages:
+
+### Graph
+
+Core implementation of the Node graph implementation. This was the first implementation of what later became known as the [Nodl framework](https://github.com/emilwidlund/nodl).
+
+### WebGL
+
+The WebGL implementation of Alma. Contains the nodes and compiler which produces the final WebGL program.
+
+### GLSL
+
+A small package which helps with creating custom visual nodes from raw GLSL functions.
+
+### Client
+
+The web application which hosts the client.
+
+### Renderer
+
+Alma's internal renderer.
diff --git a/static/alma.png b/static/alma.png
diff --git a/static/cover.png b/static/cover.png