From a998f9f201fbefcbcc61e6570919d3feab5793b5 Mon Sep 17 00:00:00 2001 From: Edoardo La Greca Date: Sun, 4 May 2025 20:16:40 +0200 Subject: add documentation --- doc/FAQ | 16 ++++++++++++++++ doc/README | 8 ++++++++ 2 files changed, 24 insertions(+) create mode 100644 doc/FAQ create mode 100644 doc/README diff --git a/doc/FAQ b/doc/FAQ new file mode 100644 index 0000000..bfc6eac --- /dev/null +++ b/doc/FAQ @@ -0,0 +1,16 @@ +Frequently Asked Questions +========================== + +Why OpenGL and not X? +--------------------- + +(Where X = Vulkan, Metal, DirectX, etc.) + +Because it's so widespread and common that I can take its support for granted. + +Why FreeGLUT and not X? +----------------------- + +(Where X = GLFW, SDL, etc.) + +Because it has and does exactly what I need. Other libraries handle a lot of other things that I don't need (e.g. audio), which translates into avoidable downsides. diff --git a/doc/README b/doc/README new file mode 100644 index 0000000..8b60404 --- /dev/null +++ b/doc/README @@ -0,0 +1,8 @@ +Documentation +============= + +In this directory you'll find pretty much all the documentation that needs to +be provided in addition to what the code and its comments tell already. + +If you have a question, head to FAQ. + -- cgit v1.2.3