From 63e1867cbc79e2a7c0422bcaaae05763d6ded095 Mon Sep 17 00:00:00 2001 From: TriantaTV Date: Sun, 24 Sep 2023 23:22:43 -0500 Subject: [PATCH] Fixed README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 8461da7..50a4333 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # n-queens +## Compiling the project + +Prerequisites + - C++11 + +In order to compile the project, simply run these two commands: + + cmake -B build -S . + cmake --build build + +## Running the Project +The program should now be compiled at ./build/bin/n_queens + +Simply run the program using: + + build/bin/n_queens + +## Usage +The program's default board size is 4 + +To change the board size use: + + build/bin/n_queens NUMBER_OF_QUEENS + +Example: + + build/bin/n_queens 8 +