add readme

1 files changed, 18 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..53e9e4d
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,18 @@
+explore rust csts, entirely in your browser. syntax elements
+are extracted using the rust-analyzer/syntax crate, and
+exposed to js via wasm.
+
+
+build:
+
+    $ nix shell
+    $ wasm-pack build
+    $ cd www && npm run build
+
+
+run:
+
+    $ xdg-open www/dist/index.html
+
+
+try it out at https://cstea.peppe.rs