Skip to content

Commit

Permalink
[client] Add README.org
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Prior committed Apr 4, 2022
1 parent 1c38397 commit a064292
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The aim of Lutrine Dice's design philosophy is to create a powerful, streamlined
| Source code | lives in the =client/= directory |
| Implementation language | [[https://www.mint-lang.com/][Mint]] |
| Main entrypoint | [[file:client/source/Main.mint][main.mint]] |
| Docs | TODO |
| Docs | [[file:client/README.org][client README]] |
| License | [[https://www.gnu.org/licenses/gpl-3.0.en.html][GNU GPLv3+]] (see [[file:client/LICENSE][client/LICENSE]]) |

** The server
Expand Down
32 changes: 32 additions & 0 deletions client/README.org
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#+TITLE: Lutrine Dice Client

* Building

To build the client and server, run ~make~.

To set up a Mint dev server with hot-relaoding, run ~make dev~. Then you can access the client on port 3001.

* Tests

** Behavior tests

The behavior tests are property-based, with specifications written in =PureScript= using [[https://quickstrom.io/][Quickstrom]]. Find them in the [[file:./specs][specs]] directory.

To run: (requires Docker)
#+begin_src bash
make check
#+end_src

This will take several minutes. On my laptop:

#+begin_src shell-session
ryan@swallowtail:~/dev/lutrine-dice$ time make check
[snip]
Passed 10 tests.

real 3m25.829s
#+end_src

** Unit tests

Not implemented yet.

0 comments on commit a064292

Please sign in to comment.