about summary refs log tree commit diff
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-07-27T10·36+0100
committerWilliam Carroll <wpcarro@gmail.com>2020-07-27T10·36+0100
commitdfe23e3b63ab61361fa34247abde006355f3914a (patch)
treea07782d99fe901a6745bd9f4180540d37f1c1f70
parent974c63a679de8975d7f6593f986d3acc47506a7d (diff)
Add instruction for operating the server
Add some basic commands for working with the server from within `ghci`, which is
helpful when developing.
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index e6d20d649e02..2e5f2f18de0e 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,29 @@
 All of the commands defined herein should be run from the top-level directory of
 this repository (i.e. the directory in which this file exists).
 
+## Server
+
+To create the environment that contains all of this application's dependencies,
+run:
+
+```shell
+$ nix-shell
+```
+
+To run the server interactively, run:
+
+```shell
+$ cd src/
+$ ghci
+```
+
+Now compile and load the server with:
+
+```
+Prelude> :l Main.hs
+*Main> main
+```
+
 ## Database
 
 Create a new database named `db.sqlite3` with: