aboutsummaryrefslogtreecommitdiffstats
path: root/docs/todolist.md
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2018-01-07 23:09:06 +0000
committerYann Herklotz <ymherklotz@gmail.com>2018-01-07 23:09:06 +0000
commit0a42123b150e06f28ae82e460e854984c2dc9648 (patch)
treea5909cde7cebe6d2d9f1a9da6f121b378846696e /docs/todolist.md
parentf066218b1fce4398588d6b139477399a15f750b7 (diff)
downloadYAGE-0a42123b150e06f28ae82e460e854984c2dc9648.tar.gz
YAGE-0a42123b150e06f28ae82e460e854984c2dc9648.zip
[Docs] Changing documentation
Diffstat (limited to 'docs/todolist.md')
-rw-r--r--docs/todolist.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/todolist.md b/docs/todolist.md
new file mode 100644
index 00000000..f36bd6e5
--- /dev/null
+++ b/docs/todolist.md
@@ -0,0 +1,35 @@
+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
+------------
+
+- It should follow the doxygen API so that documentation can easily be generated.
+
+
+Switch GPU API
+==============
+
+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
+------------
+
+- yage shouldn't depend on GL anymore and exclusively use Vulkan libraries.
+
+Afterthought
+------------
+
+In the end the library will first focus on modern OpenGL, as it is much more concise and easier to
+implement initially.