about summary refs log tree commit diff
path: root/nut-score/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'nut-score/README.md')
-rw-r--r--nut-score/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/nut-score/README.md b/nut-score/README.md
new file mode 100644
index 000000000000..585967b8beb4
--- /dev/null
+++ b/nut-score/README.md
@@ -0,0 +1,35 @@
+# Nut Score
+
+I cloned most of this start boilerplate from
+github.com/BuckleScript/bucklescript by running the following:
+
+```shell
+$ cd ~/programming
+$ git clone git@github.com:BuckleScript/bucklescript
+$ cp -R ./jscomp/bab/templates/react-hooks ~/briefcase/nut-score
+```
+
+## Installing
+
+```shell
+$ nix-shell
+$ yarn install
+```
+
+## Developing
+
+In one shell run:
+
+```shell
+$ nix-shell
+$ yarn server
+```
+
+In another shell run:
+
+```shell
+$ nix-shell
+$ yarn start
+```
+
+Now open a web browser and visit `localhost:8000`.