diff --git a/.gitignore b/.gitignore index e257658..ea784d4 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,5 @@ *.out *.app +# Building +build diff --git a/README.md b/README.md index a98785c..739737d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # search-algorithms +## 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/search-algorithms + +Simply run the program using: + + build/bin/search-algorithms