properly document project structures
This commit is contained in:
parent
d096111561
commit
4f9d957a97
@ -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
0
structure/documentation/.gitkeep
Normal file
0
structure/test/.gitkeep
Normal file
0
structure/test/.gitkeep
Normal file
0
structure/tool/.gitkeep
Normal file
0
structure/tool/.gitkeep
Normal file
Loading…
x
Reference in New Issue
Block a user