diff --git a/README.md b/README.md index 9e79c38..7c607bc 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ A console Hex Game implementation using C++. The game AI uses a Monte Carlo appr ## Installation 1. Create a folder called `build` inside the project folder. -2. Open a terminal and run the following command to generate makefiles: ```shell cmake -G "MinGW Makefiles" -S ./ -D CMAKE_C_COMPILER=gcc CMAKE_CXX_COMPILER=g++ -B build``` -3. Navigate to the build folder: ```shell cd build``` -4. Compile the game: ```shell mingw32-make -f Makefile # Windows``` and ```shell make -f Makefile # Linux/Mac``` +2. Open a terminal and run the following command to generate makefiles: ``cmake -G "MinGW Makefiles" -S ./ -D CMAKE_C_COMPILER=gcc CMAKE_CXX_COMPILER=g++ -B build`` +3. Navigate to the build folder: ``cd build`` +4. Compile the game: ``mingw32-make -f Makefile # Windows`` and ``make -f Makefile # Linux/Mac`` 5. Run tests (optional): ``ctest `` ## Troubleshooting -- If using a different CMake generator, change the ```shell -G "MinGW Makefiles"``` parameter. -- Get a list of available generators with ```shell cmake --help```. +- If using a different CMake generator, change the `-G "MinGW Makefiles"` parameter. +- Get a list of available generators with `cmake --help`. - Before changing CMake configuration, delete all files in the `build` folder. - For CLion users, open the project and build within the IDE. - Avoid using the CLion terminal to run the game due to execution delays.