munksgaard.tngl.sh
A Gleam implementation of the Scoundrel solo card game
munksgaard.me/scoundrel
lustre
scoundrel
gleam
card
game
Update README.md
+9
-17
+9
-17
README.md
+9
-17
README.md
···
1
1
# scoundrel
2
2
3
-
[](https://hex.pm/packages/scoundrel)
4
-
[](https://hexdocs.pm/scoundrel/)
5
-
6
-
```sh
7
-
gleam add scoundrel@1
8
-
```
9
-
```gleam
10
-
import scoundrel
11
-
12
-
pub fn main() -> Nil {
13
-
// TODO: An example of the project in use
14
-
}
15
-
```
3
+
An implementation of the [Scoundrel](http://www.stfj.net/art/2011/Scoundrel.pdf)
4
+
solo card game. I was inspired by watching [this
5
+
video](https://www.youtube.com/watch?v=Gt2tYzM93h4).
16
6
17
-
Further documentation can be found at <https://hexdocs.pm/scoundrel>.
7
+
## Development
18
8
19
-
## Development
9
+
Development is easiest when using nix flakes. Simply `nix develop` to enter a
10
+
dev shell with all the necessary dependencies.
20
11
21
12
```sh
22
-
gleam run # Run the project
23
-
gleam test # Run the tests
13
+
just dev # Run the development server
14
+
just cli # Run a cli game
15
+
just build # Build the static assets to be deployed
24
16
```