TetrisNerd/jminos
2
2
Fork 0
Code Issues Pull Requests 2 Actions Projects Releases 1 Wiki Activity

update readme

Browse Source
This commit is contained in:
zulianc
2025-03-23 16:53:58 +01:00
parent 92b58c4b98
commit 1781b85332
5 changed files with 21 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,8 +1,11 @@
# jminos
Modern stacker game with every polyominos from size 1 to 15, made in C++ with [SFML 3](https://www.sfml-dev.org/)!
## Manual build and run
You need to install xmake and have a compiler with c++20 compatibility
This project uses xmake for compiling.
To be able to build it, you need to [install xmake](https://xmake.io) and have a compiler with c++20 compatibility, xmake will install SFML for you.
### Build the project
@@ -15,8 +18,8 @@ If you need to change the toolchain (for example using gcc):
### Run the project
Graphical version:
``xmake run graph``
``xmake run``
Note that the program will genereate the polyomino files for you. This can be quite long so it only does it up to size 10.
Command line version:
If for some reasons you wanna run the command line version:
``xmake run text``