aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2019-01-13 23:51:25 +0100
committertv <tv@krebsco.de>2019-01-21 00:19:34 +0100
commit07f05c96390e7658851c9c15f189471b6e40bc9e (patch)
tree1bd93e7f34fc50dc63f720a2eac74bef1de062d4
parente7cf3d3c66e6c72653d7548b1226d89bf8ff2a25 (diff)
README.md: init
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fecb136
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+
+ first create a configuration file, say config.json, that looks like follows:
+
+ {
+ "nick": "somenick",
+ "useNickServ": false
+ }
+
+ or, if the nick is registered with NickServ, then:
+
+ {
+ "nick": "somenick",
+ "pass": "somepass"
+ }
+
+ then enter the Nix shell for development:
+
+ cabal2nix . > default.nix && nix-shell -I stockholm=~/stockholm
+
+ and run the REPL:
+
+ build
+ run config.json
+
+ or, interactively:
+
+ ghci -isrc -Wall src/main.hs
+ withArgs ["config.json"] main
+ :r
+