From e7f442ee03dc25ab5a00805ba103c34eb6ae963a Mon Sep 17 00:00:00 2001 From: Isaac Da Pena <56054255+idapena@users.noreply.github.com> Date: Fri, 16 Feb 2024 00:48:16 -0400 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7c607bc..9e79c38 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: ``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`` +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``` 5. Run tests (optional): ``ctest `` ## Troubleshooting -- If using a different CMake generator, change the `-G "MinGW Makefiles"` parameter. -- Get a list of available generators with `cmake --help`. +- If using a different CMake generator, change the ```shell -G "MinGW Makefiles"``` parameter. +- Get a list of available generators with ```shell 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.