readme completed
This commit is contained in:
21
README.md
21
README.md
@@ -4,10 +4,9 @@ Modern stacker game with every polyominoes from size 1 to 15, made in C++ with [
|
||||
|
||||
## Download
|
||||
|
||||
// TODO when the game is finished //
|
||||
|
||||
This game has been tested on and built for Windows 11 and WSL2 Ubuntu.
|
||||
If your OS isn't compactible with either of theses two, you can try [manually building the project](#manual-build).
|
||||
You can download the latest release [here](https://git.ale-pri.com/TetrisNerd/jminos/releases)!
|
||||
This game has been tested on Windows 11 and Linux, and releases are provided for theses two systems.
|
||||
If your OS isn't compatible, you can try [manually building the project](#manual-build).
|
||||
|
||||
## How to play
|
||||
|
||||
@@ -60,6 +59,8 @@ AutoRS demonstration
|
||||
This project uses xmake for compiling, xmake is cross-platform and works in most OS, xmake also automatically install supported librairies.
|
||||
To be able to build this project, you need to [have xmake installed](https://xmake.io) and have a compiler with C++20 compatibility.
|
||||
|
||||
If you want to contribute or are simply curious, you can check the [wiki](https://git.ale-pri.com/TetrisNerd/jminos/wiki)!
|
||||
|
||||
### Build the project
|
||||
|
||||
``cd jminos``
|
||||
@@ -69,6 +70,9 @@ To be able to build this project, you need to [have xmake installed](https://xma
|
||||
If you need to change the toolchain (for example using gcc):
|
||||
``xmake f --toolchain=gcc``
|
||||
|
||||
If you want to build for another platform (for example with mingw):
|
||||
``xmake f -p mingw``
|
||||
|
||||
### Run the project
|
||||
|
||||
``xmake run``
|
||||
@@ -86,7 +90,13 @@ The command line version is **not** updated.
|
||||
|
||||
### Package the project
|
||||
|
||||
// TODO when the game is finished //
|
||||
To package the executable manually properly, follow theses steps:
|
||||
|
||||
1. Clone the project into a new folder.
|
||||
2. If you already have all 15 pieces files, copy them over to the ``data/pieces`` folder, else you will be generating them at the next step.
|
||||
3. Go into release mode (``xmake f -m release``) and run the project once (``xmake`` and ``xmake run``). This is to generate the default config files, close the game immediately after it started.
|
||||
4. Make a new folder named ``jminos`` and copy the executable (should be located somewhere like ``build/linux/x86_64/release/graph``) as well as the ``data/pieces`` and ``data/config`` folders.
|
||||
5. Zip the newly created ``jminos`` folder into a file named ``jminos_{platform}``.
|
||||
|
||||
## Benchmarks
|
||||
|
||||
@@ -112,7 +122,6 @@ The command line version is **not** updated.
|
||||
|
||||
_File storing includes type checking and sorting all polyominoes before writing them to the file._
|
||||
The files are compressed, they used to be about 5x as large.
|
||||
If you want to know more details about the generation and storage of polyominoes, [check the documentation](/doc/)!
|
||||
|
||||
Run it yourself by typing:
|
||||
``xmake f -m release``
|
||||
|
||||
Reference in New Issue
Block a user