Readme mit Doku-Template, Slides-Ordner
parent
68da5e7e84
commit
5f56e0dcd3
@ -1,5 +1,4 @@
|
||||
# Projektspezifische Hardware
|
||||
|
||||
Die EDA/CAD-Dateien und BOM von Erweiterungsplatinen. Dokumentation ist in der Repository-Wiki zu hinterlegen.
|
||||
|
||||
Die EDA/CAD-Dateien und BOM von Erweiterungsplatinen.
|
||||
Präferierte EDA-Software: [KiCad](https://kicad-pcb.org/).
|
||||
|
||||
@ -1,26 +1,42 @@
|
||||
# DMM-Demo
|
||||
|
||||
Zum Flashen des Bootloaders und des Demonstrationsprojektes siehe [Firmware/README.md](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-demo/-/tree/master/Firmware)
|
||||
Zum Flashen des Bootloaders und des Demonstrationsprojektes siehe
|
||||
[Firmware/README.md](https://teach.emg.ing.tu-bs.de/git/dmm/dmm-demo/-/tree/master/Firmware)
|
||||
|
||||
## Erstellen eines DMM-Projektes
|
||||
Die Dokumentation ist in diesem README zu hinterlegen. Das Einfügen von Bildern
|
||||
aus der Git-Repository ist erwünscht, diese sollten aber nicht zu groß sein.
|
||||
Bei der Struktur kann grob am nachfolgenden Template orientiert werden.
|
||||
|
||||
> Aktuell kann das Projekt aufgrund eines [GitLab-Bugs](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38381)
|
||||
> nicht per GUI in die Untergruppe geforkt werden. Das lässt sich jedoch leicht manuell bewerkstelligen.
|
||||
# Name des Projektes
|
||||
|
||||
Jede Gruppe bestimmt **einen Maintainer**, der ein gemeinsames Projekt erstellt. Dieser geht wie folgt vor.
|
||||
* Falls nicht schon geschehen, Rechte in der Semester-Untergruppe (z.B. DMM/SoSe2020) per Link "Request Access" neben dem Gruppennamen beantragen.
|
||||
* Sicherstellen, dass sein Git mit Namen/E-mail eingerichtet und SSH-Schlüssel im GitLab unter `Nutzermenü->Settings->SSH Keys` hinterlegt ist.
|
||||
* In der Semester-Untergruppe einen neuen Projekt (hier: my-project) erstellen.
|
||||
* Das Demoprojekt unter dem neuen Namen auschecken:
|
||||
Eigene Beschreibung des Projektes.
|
||||
|
||||
`$ git clone git@teach.emg.ing.tu-bs.de:dmm/dmm-demo.git my-project`
|
||||
* Die Remote auf das neue Projekt umstellen:
|
||||
### Gruppenmitglieder
|
||||
* Dr.-Ing. Martin Oehler
|
||||
* Dipl.-Ing. Timo Klingeberg
|
||||
* Christof Wehrmann, M.Sc.
|
||||
* Ilya Elenskiy, M.Sc. (@ilyelens)
|
||||
|
||||
`$ git remote set-url origin git@teach.emg.ing.tu-bs.de:dmm/sose2020/my-project.git`
|
||||
* In das neue Projekt hochladen:
|
||||
>>>
|
||||
**Aufgabenstellung des emg:**
|
||||
|
||||
`$ git push --set-upstream origin master`
|
||||
* Auf der GitLab-Seite des Projektes links im Menu unter `Settings->Members` seine Gruppenkameraden als Developer hinzufügen.
|
||||
* Unter `Settings->General->Visibility, project features, permissions` die Wiki sowie optional Issues aktivieren.
|
||||
* Wiki-Home entsprechend dem Template aus dem Wiki der DMM-Demo einrichten.
|
||||
|
||||
Es ist mit dem DMM-Board XYZ zu implementieren...
|
||||
>>>
|
||||
|
||||
### Aufgabenverteilung
|
||||
@ilyelens: PlatformIO eindrichten, PWM-Demonstration.
|
||||
...
|
||||
|
||||
### Zeitplan
|
||||
...
|
||||
|
||||
## Dokumentation
|
||||
### Hardware
|
||||
Bauteilliste, Dokumentation, ...
|
||||
|
||||
### Software
|
||||
Dokumentation
|
||||
|
||||
## Ergebnisse
|
||||
|
||||
Bilder oder Auswertungen vom Tests, ggf. Link zum Video usw.
|
||||
@ -0,0 +1,3 @@
|
||||
# Präsentation
|
||||
|
||||
Hier soll die Präsentation (ggf. mit LaTeX Code) hinterlegt werden.
|
||||
Loading…
Reference in New Issue