diff --git a/README.md b/README.md index f4ac7a0..9b10cfe 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CPlusPlus Laboratory +# C++ Lab ## What is? @@ -10,3 +10,17 @@ In a nutshell this project has the sole purpose to serve as a learning platform You can understand in a practical way how you can manage the memory manually. How you can avoid some of the most pitfalls like memory leak problems by following practices like [RAII](https://en.wikipedia.org/wiki/Resource_acquisition_is_initialization). By exploring the technics that revolve around memory allocation you can understand in a more profound way how languages like java, python, and rust manage memory and the obvious tradeoffs involved. +## How to run this? + +This c++ project uses premake5. Premake will generate the build files needed based on the development environment you need. + +In my particular use case I use linux and the `gmake` profile to build this project. + +I run, as an example + +```shell +premake5 gmake +make +``` + +Premake consumes the `premake5.lua` file. This in turn will include other premake files that you can find in the [premake](premake/) directory. \ No newline at end of file