tvl-depot/README.org

#+TITLE: Xanthous

* Building

#+BEGIN_SRC shell
$ nix build
#+END_SRC

* Running

#+BEGIN_SRC shell
$ ./result/bin/xanthous [--help]
#+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
An @-sign in a box, in haskell Initial commit of a Haskell version of Xanthous, written using Brick and built with Nix. This is so much nicer and so much easier 2019-08-25 19:28:10 +02:00			`#+TITLE: Xanthous`
Add build and run instructions to the README just for the heck of it. 2019-11-30 20:13:07 +01:00
			`* Building`

			`#+BEGIN_SRC shell`
			`$ nix build`
			`#+END_SRC`

			`* Running`

			`#+BEGIN_SRC shell`
Use correct bin path in README nix build for a haskell package makes a directory, not just a bare binary. 2019-12-01 00:25:32 +01:00			`$ ./result/bin/xanthous [--help]`
Add build and run instructions to the README just for the heck of it. 2019-11-30 20:13:07 +01:00			`#+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`