From 9c90ddd5eef6d40b874d17b1a88aabb4c0b33894 Mon Sep 17 00:00:00 2001 From: anulax1225 Date: Thu, 25 Jan 2024 15:04:13 +0100 Subject: [PATCH] Added mainpage documentation --- manual/index.dox | 4 ---- manual/index.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 4 deletions(-) delete mode 100644 manual/index.dox create mode 100644 manual/index.md diff --git a/manual/index.dox b/manual/index.dox deleted file mode 100644 index 1fbccdf..0000000 --- a/manual/index.dox +++ /dev/null @@ -1,4 +0,0 @@ -/*! \mainpage Bakara Manual -

Build

-

Examples

-*/ \ No newline at end of file diff --git a/manual/index.md b/manual/index.md new file mode 100644 index 0000000..bbe0494 --- /dev/null +++ b/manual/index.md @@ -0,0 +1,35 @@ +\mainpage Bakara Manual + +## Build +On windows, make sure you have ms-compiler for C++.
+Then write commands : +```bash + git clone https://github.com/anulax/bakara + git submodule init + git submodule update + .\vendor\premake5 vs2022 + dotnet build + dotnet run +``` +Or use vs2022 to build your project. + +--- +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 +``` +--- +## Tuto +(to do)