about summary refs log tree commit diff
path: root/client/README.md
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-07-29T08·51+0100
committerWilliam Carroll <wpcarro@gmail.com>2020-07-29T08·51+0100
commit289cae2528946aa5d745e904cdaaec7df1a71493 (patch)
treebef174f051aa60e7a388a3383b8b19d65b5cbffb /client/README.md
parentcf6c8799ab86278c827d4236a7a89163c61c29b9 (diff)
Add Elm boilerplate to project
Create a top-level client directory to store my Elm boilerplate.
Diffstat (limited to 'client/README.md')
-rw-r--r--client/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/client/README.md b/client/README.md
new file mode 100644
index 000000000000..425d5163ea35
--- /dev/null
+++ b/client/README.md
@@ -0,0 +1,17 @@
+# Elm
+
+Elm has one of the best developer experiences that I'm aware of. The error
+messages are helpful and the entire experience is optimized to improve the ease
+of writing web applications.
+
+## Developing
+
+If you're interested in contributing, the following will create an environment
+in which you can develop:
+
+```shell
+$ nix-shell
+$ elm-live -- src/Main.elm --output=Main.min.js
+```
+
+You can now view your web client at `http://localhost:8000`!