anon/chad_standard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

properly document project structures

Browse Source
This commit is contained in:
anon 2024-11-23 16:01:28 +01:00
parent d096111561
commit 4f9d957a97
4 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
structure/README.md
View File

@ -0,0 +1,15 @@
# /chad/ structure
This directory showcases how a chad compliant project directory looks like.
| Directory | Use |
| :-------: | :---: |
| documentation/ | Documentation regarding the project and hard to come by or custom documentation for developers (library, API and or theoritical papers and such). |
| source/ | Soure code required to produce the projects main target. Headers belong here too. |
| tool/ | Helper scripts and programs used during development. |
| test/ | Test scripts and test inputs. |
### Recommended tools
+ git
+ GNU Make
+ cmdtest

0
structure/documentation/.gitkeep Normal file
View File

0
structure/test/.gitkeep Normal file
View File

0
structure/tool/.gitkeep Normal file
View File