summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2024-01-03 14:16:36 +0100
committerxengineering <me@xengineering.eu>2024-01-03 14:16:36 +0100
commit154c19fea79e14ed8832b861e5d05a79238c423c (patch)
treec8507f450d918957d8c9488be8151f1e657d620e
parent2a4eef0fb039a0704a3081c41c136282ff914ba8 (diff)
downloadsoundbox-154c19fea79e14ed8832b861e5d05a79238c423c.tar
soundbox-154c19fea79e14ed8832b861e5d05a79238c423c.tar.zst
soundbox-154c19fea79e14ed8832b861e5d05a79238c423c.zip
Write 'Build instructions' for the README
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index cdfcabe..156f9ee 100644
--- a/README.md
+++ b/README.md
@@ -36,3 +36,18 @@ 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.
+
+## Build instructions
+
+To build the contents of this repository the following software tools are
+required:
+
+- Linux operating system
+- GNU coreutils
+- GNU make
+- pdflatex
+- OpenSCAD
+- Prusa Slicer
+
+A full build can be started with `make`. The results can be removed with `make
+clean`.