From ec1985873f69a851815870d9f24f6d6013771330 Mon Sep 17 00:00:00 2001
From: cinnaboot <cinnaboot@protonmail.com>
Date: Sun, 7 Nov 2021 11:14:13 -0500
Subject: [PATCH] add project description to the top of renderer.h

also move some fixme and todo comments to the top of renderer.h
---
 README             |  2 +-
 include/renderer.h | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 14a58bb..8a38bb7 100644
--- a/README
+++ b/README
@@ -32,7 +32,7 @@ Build Instructions:
 			$ sudo pacman -S glew glm sdl2 gcc make
 		Fedora)
 			$ sudo dnf install glew-devel glm-devel SDL2-devel gcc-c++ make
-	checkout, and initialize submodules: (stb_image)
+	checkout, and initialize submodules: (stb_image, tinygltf)
 		$ git submodule init
 		$ git submodule update
 	(optional) checkout large files for running examples:
diff --git a/include/renderer.h b/include/renderer.h
index 559c15c..6b44798 100644
--- a/include/renderer.h
+++ b/include/renderer.h
@@ -1,3 +1,23 @@
+/*
+ * libTangerine, a small, modern openGL renderer specializing in flat shaded,
+ * 	solid color models using pallete textures. See README for build instructions
+ * 	and look in the examples folder for... examples
+ *
+ * fixmes)
+ * FIXME: remove mesh.h, mesh.cpp
+ * FIXME: remove platform_wait_for_vblank
+ * FIXME: clean up examples with new asset system
+ * FIXME: merger render_group_fix branch back into master
+ * FIXME: make a test case for overflowing default array sizes, rg->assets
+ * 	rg_info->groups, render_group->enitities, rg->textures
+ * FIXME: look for glm::mat4 in structs, and replace with pointers
+ * FIXME: better shader abstraction so we can store a list of shaders on
+ * 	render_state
+ *
+ * todos)
+ * TODO: make assetInit* functions generic
+ * TODO: make initModel/initTexture functions generic
+ */
 
 #pragma once