Merge pull request #99 from ntut-rick/doxygen

Update README

README.md

@@ -1,16 +1,35 @@
 # Practical Tools for Simple Design
 
+###### Officially Supported Platforms and IDEs
+
+|                                | Windows | macOS | Linux |
+|:------------------------------:|:-------:|:-----:|:-----:|
+|             CLion              |    V    |   V   |   V   |
+|        VSCode[^codeoss]        |    V    |   V   |   V   |
+| Visual Studio[^novs][^vsmacos] |    ?    |   X   |   X   |
+|             No IDE             |    V    |   V   |   V   |
+
+[^vsmacos]: [Microsoft Kills Visual Studio for Mac](https://visualstudiomagazine.com/articles/2023/08/30/vs-for-mac-retirement.aspx)
+[^codeoss]: On Linux the support of Code - OSS and VSCodium aren't guaranteed.
+[^novs]: Due to lack of testing there may or may not be more issues on VS. Anyway, building PTSD on VS is available.
+
 ## Getting Started
 
-Required: Git, CMake, C/C++ compiler
+Required: Git, CMake, C/C++ Compiler, OpenGL Implementation
+
+Optional: Ninja Build, Clang
 
-Optional: Ninja Build, clang
+> You might get some issue like https://github.com/ntut-open-source-club/practical-tools-for-simple-design/issues/78 check it if you need.
 
 ### Command Line
 
-```
-git clone https://ntut-open-source-club/practical-tools-for-simple-design.git
+[//]: # (TODO: No IDE Quick Start)
+> [!WARNING]  
+> This section is work in progress.
 
+```
+git clone https://github.com/ntut-open-source-club/practical-tools-for-simple-design.git
+cd practical-tools-for-simple-design
 cmake -B build
 cmake --build build
 ```
@@ -30,15 +49,17 @@ cmake --build build
 
 ### VSCode
 
-TODO
+[//]: # (TODO: VSCode Quick Start)
+> [!WARNING]  
+> This section is work in progress.
 
 ### CLion
 
-TODO
-
-### Visual Studio
+[//]: # (TODO: Clion Quick Start)
+> [!WARNING]  
+> This section is work in progress.
 
-TODO
+###### NOTE: If you have time, read [OOP2023f Environment Setup](https://hackmd.io/@OOP2023f/rk2-8cVCh)
 
 ## Generate Doxygen Documents
 

docs/Doxyfile

@@ -918,6 +918,9 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = include
+INPUT                 += README.md
+# INPUT                 += CONTRIBUTING.md
+# INPUT                 += .github/docs
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1131,7 +1134,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common