1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00ff565
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+## modular slang
+
+the idea here is just to make something like slangc.exe, but which doesn't
+require an entrypoint.
+
+build instructions
+
+```bash
+git clone https://github.com/shader-slang/slang
+git submodule update --init --recursive -j 32
+# wait, the previous command takes a while
+mkdir slang/build
+cd slang/build
+# run this part in powershell, from ./slang/build
+cmake.exe ..
+cmake.exe --build . -j
+# the previous command will take a long fucking time
+# switch back to top level of repo
+cd ../..
+# do this in wsl2 or powershell. Showing wsl2/bash syntax
+# you'd do this for each incremental build.
+powershell.exe ./build.ps1 && ./build/bin/Release/modular_slange.exe ./test.slang
+```
+