Add readme

This commit is contained in:
Rampoina 2023-01-03 20:49:57 +01:00
parent af85ad5920
commit ac5d6efaea
3 changed files with 27 additions and 0 deletions

3
.gitmodules vendored Normal file
View File

@ -0,0 +1,3 @@
[submodule "CBQN"]
path = CBQN
url = https://github.com/dzaima/CBQN.git

1
CBQN Submodule

@ -0,0 +1 @@
Subproject commit 982a54d98a4d2a37f40d0cc711b0ad5e396613e3

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# A 2048 game made in [BQN](https://github.com/mlochbaum/BQN)
## Controls
Vim style movement keys
- h: left
- j: down
- k: up
- l: right
- q: quit
## Running
If you already have BQN and you have it on your path just run `./soko.bqn`
Otherwise:
1. `make` to compile CBQN
2. `make run` to run the game
## License
This code is licensed as AGPLv3