diff --git a/README.md b/README.md index 8cc0e89..67b0651 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,31 @@ the documentation for the language (and compiler) can be found [here WIP](https: ### Build -``` +##### Windows + +```powershell git clone https://github.com/PashaBibko/LXC.git LXC cd LXC -mkdir -p build +git submodule update --init --recursive +mkdir build +cd build +cmake .. -G Ninja +cmake --build . +``` + +##### UNIX based + +```bash +git clone https://github.com/PashaBibko/LXC.git LXC +cd LXC +git submodule update --init --recursive +mkdir build cd build cmake .. cmake --build . ``` -##### Windows - -The .exe will be located in the LXC/(Debug or Release) folder. - -##### UNIX based - -The outputted binary will be located in the LXC folder. - ##### Other Operating systems that are not listed above are not supported. To run the code you will have to modify it yourself. -All code that should need to be changed is within the [Common folder](https://github.com/PashaBibko/LXC/tree/main/Common). +All code that should need to be changed is within the [Common modules](https://github.com/PashaBibko/LXC/tree/main/Common/modules).