blob: 8b83ec38efeb1e298fd25931cc8994b0240eb48a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# 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
│ └── 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.
## Build instructions
To build the contents of this repository the following software tools are
required:
- Linux operating system
- GNU coreutils
- GNU make
- pdflatex
- Inkscape
- OpenSCAD
- Prusa Slicer
A full build can be started with `make`. The results can be removed with `make
clean`.
|
