Fixed README
This commit is contained in:
parent
00b7981c81
commit
63e1867cbc
28
README.md
28
README.md
@ -1,2 +1,30 @@
|
|||||||
# n-queens
|
# 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
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user