diff --git a/README.md b/README.md index 32b7889..4271822 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # pwdin -Function to prompt users for a password of other secret. \ No newline at end of file +Function to prompt users for a password or other secrets. + +## Build + +To build the library one needs to simply use premake5 to generate the Makefile: + + premake5 gmake + +And then needs to build the library in release mode: + + make config=release + +The StaticLib is then available under `bin/Release/libpwdin.a`. \ No newline at end of file