From 8cc987d5db3cd5df9353098ec4877fbc9c12f564 Mon Sep 17 00:00:00 2001 From: anulax1225 Date: Mon, 29 Jan 2024 11:07:21 +0100 Subject: [PATCH] Added build imtructions in mainpage on the readme --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d059c0..3424240 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,44 @@ ## Resume +## Generate doc + ## Prerequiste +* A video/graphics card that supports OpenGL. +### Windows +* C++ ms-compiler for Windows +### Linux +* GCC compiler suite. ## Build +### Windows +On windows, write commands : +```batch + git clone https://github.com/anulax/bakara + git submodule init + git submodule update + .\vendor\premake5 vs2022 + dotnet build + dotnet run +``` +Or use visual studio 2022 to build your project. +### Linux +--- +On linux (if you don't have premake5, install it with your distro's packet manager). You have two env variable to change build proccess : + +| Name | Value | +| ----------- | ----------- | +| autoexec | 0/1 | +| clearbin | 0/1 | + +Then write commands : +```bash + git clone https://github.com/anulax/bakara + git submodule init + git submodule update + (export clearbin=1 autoexec=1) + ./build.sh config=release +``` -## Generate documentation \ No newline at end of file +## Getting started +(to do) \ No newline at end of file