From 4f9d957a971b15653f7682d3d00513fb14a0b34b Mon Sep 17 00:00:00 2001 From: anon Date: Sat, 23 Nov 2024 16:01:28 +0100 Subject: [PATCH] properly document project structures --- structure/README.md | 15 +++++++++++++++ structure/documentation/.gitkeep | 0 structure/test/.gitkeep | 0 structure/tool/.gitkeep | 0 4 files changed, 15 insertions(+) create mode 100644 structure/documentation/.gitkeep create mode 100644 structure/test/.gitkeep create mode 100644 structure/tool/.gitkeep diff --git a/structure/README.md b/structure/README.md index e69de29..49d657d 100644 --- a/structure/README.md +++ b/structure/README.md @@ -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 diff --git a/structure/documentation/.gitkeep b/structure/documentation/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/structure/test/.gitkeep b/structure/test/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/structure/tool/.gitkeep b/structure/tool/.gitkeep new file mode 100644 index 0000000..e69de29