From 806fe2854638fac55b19e5814645770931885339 Mon Sep 17 00:00:00 2001 From: anulax1225 Date: Mon, 29 Jan 2024 16:07:12 +0100 Subject: [PATCH] Changed mainpage of the doc and the README --- README.md | 8 ++++++++ manual/index.md | 1 - 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3424240..6bf3aec 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ ## Resume ## Generate doc +To generate the documentation using doxygen, install it from there website for your plaform. +Then write commands : +```bash + cd dirs/to/bakara + doxygen +``` ## Prerequiste * A video/graphics card that supports OpenGL. @@ -15,6 +21,7 @@ ### Windows On windows, write commands : ```batch + cd C:\Users\username git clone https://github.com/anulax/bakara git submodule init git submodule update @@ -34,6 +41,7 @@ On linux (if you don't have premake5, install it with your distro's packet manag Then write commands : ```bash + cd ~/ git clone https://github.com/anulax/bakara git submodule init git submodule update diff --git a/manual/index.md b/manual/index.md index 871dcbd..b85d52a 100644 --- a/manual/index.md +++ b/manual/index.md @@ -14,7 +14,6 @@ On windows, write commands : 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 |