add build instructions to the readme

2024-02-23 20:31:03 +00:00 · 2024-02-23 20:31:03 +00:00 · 7a582b216e
parent fe2e42a3f2
commit 7a582b216e
2 changed files with 19 additions and 1 deletions
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@ -3,4 +3,4 @@ project(passwdgen)

 set(CMAKE_CXX_STANDARD 20)

-add_executable(passwdgen passwdgen.cpp)
+add_executable(passwdgen passwdgen.cpp)
--- a/README.md
+++ b/README.md
@ -2,3 +2,21 @@
 ### a rudimentary random string password generator

 For demo purposes only
+
+## Build
+
+**Bare Bones**
+```bash
+mkdir build
+g++ -o build/passwdgen ./passwdgen.cpp
+```
+
+**From CMAKE**
+```bash
+mkdir build
+cd build
+cmake ..
+make 
+```
+
+Then, just copy the compiled binary to somewhere on your $PATH