Updated README and fixed gitignore

2023-08-31 18:58:11 -05:00 · 2023-08-31 18:58:11 -05:00 · e0655c7f04
commit e0655c7f04
parent c18481228a
2 changed files with 18 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -32,3 +32,5 @@
 *.out
 *.app

+# Building 
+build
--- 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