about summary refs log tree commit diff
path: root/README.org
blob: 5d3b2af0485ae4e4a979431f30e7399369079ce9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#+TITLE: Xanthous

* Building

#+BEGIN_SRC shell
$ nix build
#+END_SRC

* Running

#+BEGIN_SRC shell
$ ./result
#+END_SRC

** Keyboard commands

Keyboard commands are currently undocumented, but can be found in [[[https://github.com/glittershark/xanthous/blob/master/src/Xanthous/Command.hs#L26][this file]].
Movement uses the nethack-esque hjklybnu.

* Development

#+BEGIN_SRC shell
$ nix-shell

# Build (for dev)
[nix-shell:xanthous]$ cabal new-build

# Run tests
[nix-shell:xanthous]$ cabal new-run test

# Run a repl
[nix-shell:xanthous]$ cabal new-repl
#+END_SRC