Files
audio-synth/docs/README.md
Erik Tóth a16f48f1b2 README.md - Update 3
TO-DO Liste
2025-09-10 13:15:23 +02:00

55 lines
2.7 KiB
Markdown

# ANALOGER AUIDOSYNTHESIZER MIT DIGITALER STEUEREINHEIT
von Wendelin Waldhart und Erik Tóth
## Themenaufteilung
| Thema | Verantwortlicher |
|:---|:---:|
| Analog | [@Wendl06](https://github.com/Wendl06) |
| 3D-Print | [@Wendl06](https://github.com/Wendl06) |
| Digital | [@erik-toth](https://github.com/erik-toth) |
| PCB | [@erik-toth](https://github.com/erik-toth) |
## Github Projektstruktur
> [!NOTE]
> Einige Unterordner sind im Moment noch nicht angelegt da noch keine Daten in ihnen liegen. Wenn ein Unterordner noch nicht vorhanden ist, einfach einen Ordner laut der unten gezeigten Struktur erstellen.
### Ordner Erklärung
In _docs_ werden alle selbstgefertigten Words und PDFs gesammelt, die zum jeweiligen Thema als Einzelarbeiten erstellt worden sind (Bsp. OTA-Erklärung -> analog, ESP32-Erklärung -> digital).\
In _dev_ werden alle Entwicklungsdateien zu einem Thema gespeichert, u.a. 3D-Objekte für die Print, Altium-Simulationen usw. Auch hier wieder auf eine gute Ordnung achten. \
In _lit_ werden alle Literaturverweise, die zur Ausarbeitung für die Diplomarbeit verwendet worden, abgespeichert. Entweder als PDF (Bücher, Datasheehts, Blog-Posts, ...) oder/und in die [lit.csv](/lit/lit.csv) als Link (für Videos, Blog-Posts, ...).\
Die eigentliche __Diplomarbeit__ und die dazugehörigen (finalen) Fertigungsunterlagen werden in den jeweiligen _general_ Ordnern gespeichert.
### Ordner Struktur
- [audio-synth](/)
- [docs](/docs/)
- [general](/docs/general)
- [analog](/docs/analog)
- [digital](/docs/digital)
- [pcb](/docs/pcb)
- [3d_print](/docs/3d_print)
- [dev](/dev/)
- [general](/dev/general)
- [analog](/dev/analog)
- [digital](/dev/digital)
- [pcb](/dev/pcb)
- [3d_print](/dev/3d_print)
- [da_altium_lib](/dev/da_altium_lib)
- [lit](/lit/)
## Allgemeine Infos
> [!NOTE]
> Dieses Github-Repository dient nur zum Datenaustausch für die Erstellung der Diplomarbeit.
> [!CAUTION]
> Da MS-Word Dokumente nicht für die Versionskontrolle über Github gemacht ist, kommt es dabei öfters Mal zu Problemen. Deswegen empfiehlt es sich DOCX-Dateien vorerst nur lokal zu speichern und eine fertige PDF, sowie die dazugehörgie DOCX-Datei, erst zum Schluss aufs Repo zu laden.
> [!IMPORTANT]
> Die eigentliche Diplomarbeits DOCX wird über das MS-Sharepoint (standardmäßige Dokumenten-Teilfunktion von Word) mit einander geteilt.
## TO-DO Liste
- [ ] Literaturrechreche
- [ ] Schaltungsentwurf
- [ ] Simulationen
- [ ] Gesamt System zusammengeführt
- [ ] Prototyp entwickeln und bestellen (Deadline: Bis Weihnachtsferien)
- [ ] Start Diplomarbeit dokumentieren
- [ ] Ende Diplomarbeit