aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9625e27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+
+### Development mode
+To start the Figwheel compiler, navigate to the project folder and run the following command in the terminal:
+
+```
+lein figwheel
+```
+
+Figwheel will automatically push cljs changes to the browser.
+Once Figwheel starts up, you should be able to open the `public/index.html` page in the browser.
+
+### REPL
+
+The project is setup to start nREPL on port `7002` once Figwheel starts.
+Once you connect to the nREPL, run `(cljs)` to switch to the ClojureScript REPL.
+
+### Building for production
+
+```
+lein clean
+lein package
+```