summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-03 13:34:27 +0100
committerxengineering <me@xengineering.eu>2024-01-03 14:10:36 +0100
commit2a4eef0fb039a0704a3081c41c136282ff914ba8 (patch)
treedcc365f155406359453c43a5030b31683f0323de /README.md
parentb9ecbb7c782fed6256ce2a0da80bde17a4c24fa9 (diff)
downloadsoundbox-2a4eef0fb039a0704a3081c41c136282ff914ba8.tar
soundbox-2a4eef0fb039a0704a3081c41c136282ff914ba8.tar.zst
soundbox-2a4eef0fb039a0704a3081c41c136282ff914ba8.zip
Write 'Repository overview' for README
Providing a structural overview inside the README should help developers new to the repository to get familiar with it.
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5703698..cdfcabe 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
# soundbox
soundbox is a device to connect classic audio systems to the network.
+
+## Repository overview
+
+The following listing provides an overview of the repository structure:
+
+```
+.
+├── build
+├── doc
+│ ├── LICENSE.txt
+│ └── soundbox-documentation.tex
+├── Makefile
+├── mech
+│ ├── assembly.scad
+│ ├── LICENSE.txt
+│ ├── parameters.scad
+│ ├── pcb_case
+│ │ └── tolerance_tests.scad
+│ ├── production.scad
+│ └── prusa-slicer
+│ └── anycubic_i3_mega_s.ini
+└── README.md
+```
+
+The repository root contains the given `README`, a Makefile which allows to
+build everything with GNU make, the build folder and further folders for
+different aspects of the device.
+
+The `doc` folder contains everything to build the PDF documentation which is
+generated during a full build. It contains all documentation aspects except the
+content covered in the given `README`.
+
+Mechanical design is handled inside the `mech` directory. It consists of source
+files for OpenSCAD aswell as configuration file(s) for the Prusa Slicer
+software.