diff options
| author | Yann Herklotz <ymherklotz@gmail.com> | 2018-04-03 08:43:26 +0100 |
|---|---|---|
| committer | Yann Herklotz <ymherklotz@gmail.com> | 2018-04-03 08:43:26 +0100 |
| commit | 0d10ba12062144a270a368ef9bffd88517a6c27c (patch) | |
| tree | bd25a1667b27a71d58a3dc05ec2aa54087add699 | |
| parent | 9ed192ad930c5657b58721c388cd1e6537035328 (diff) | |
| download | YAGE-0d10ba12062144a270a368ef9bffd88517a6c27c.tar.gz YAGE-0d10ba12062144a270a368ef9bffd88517a6c27c.zip | |
Adding documentation
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/matrix.md | 11 | ||||
| -rw-r--r-- | docs/todolist.md | 23 |
3 files changed, 15 insertions, 23 deletions
@@ -5,7 +5,7 @@ ## Introduction YAGE stands for Yet Another Game Engine. It is a 2D game engine that is being -developed for the game [Arider](https://github.com/ymherklotz/Arider). However, +developed for the game [Arider](https://github.com/ymherklotz/Arider "Arider"). However, it will also be general game engine library for any other 2D games. YAGE uses OpenGL for rendering of 2D graphics. OpenGL was chosen because it is @@ -67,7 +67,7 @@ yage::init(); It can be then cleaned up by running. -``` objective-c++ +``` c++ yage::quit(); ``` diff --git a/docs/matrix.md b/docs/matrix.md index 93138bb9..21f63395 100644 --- a/docs/matrix.md +++ b/docs/matrix.md @@ -1,21 +1,18 @@ -Matrix Guide {#matrix_guide} -============ +# Matrix Guide {#matrix_guide} The matrix class is a templated class which implements a mathematical %Matrix. -Usage Guide ------------ +## Usage Guide The class can be instantiated -Example Code ------------- +## Example Code Creating a %Matrix and performing operations on it. -``` c++ +``` #include <YAGE/Math/matrix.hpp> int main(int, char **) diff --git a/docs/todolist.md b/docs/todolist.md index f36bd6e5..94d16a7e 100644 --- a/docs/todolist.md +++ b/docs/todolist.md @@ -1,35 +1,30 @@ -Add Comments -============ +# TODO list -Reason ------- +## Add Comments + +### Reason Currently there are no comments in the code. They should be added so that in the future the code can be edited easily and improved without having to know the exact implementation of every function. -Requirements ------------- +### Requirements - It should follow the doxygen API so that documentation can easily be generated. -Switch GPU API -============== +## Switch GPU API -Reason ------- +### Reason Vulkan is much more straight forward and it should be easier to understand OpenGL from it. I also the newest API that will be used in the newest games and is supported by quite a few graphics cards. -Requirements ------------- +### Requirements - yage shouldn't depend on GL anymore and exclusively use Vulkan libraries. -Afterthought ------------- +### Afterthought In the end the library will first focus on modern OpenGL, as it is much more concise and easier to implement initially. |