curious.bio/myzel-akustikabsorber
curious.bio/myzel-akustikabsorber
6
0
Fork 1
Code Issues Pull requests Packages Projects 4 Releases Wiki Activity

Merge pull request 'contributionguide' (#98) from contributionguide into main

Browse source 
Reviewed-on: #98
This commit is contained in:
thies 2023-02-17 15:23:40 +01:00
parent 1e7bff9d47 356bc8e809
commit 3c740b8f7c
3 changed files with 23 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -19,16 +19,16 @@ Abgesehen vom Befestigungssytem, besteht die Akustikabsorber ausschließlich aus
Das Repository ist modular aufgebaut. Die Readme [Materialherstellung](mod/material_fabrication/README.md) im Ordner mod/material_fabrication beschreibt den grundlegenden Herstellungsprozess. Die weiteren Module anchor, mould und mounting_system beschreiben die Herstellung von Teilaspekten, die für die Fertigung des Absorbers notwendig sind.
Eine Gebrausanweisung ist in dem [user manual](doc/usage/user_manual.md) beschrieben.
Über einen Beitrag oder Verbesserungsvorschlag zu dieser Dokumentation, würden wir uns sehr freuen. Wie Sie dies machen können, finden Sie im [Contribution guide](doc/contributing/CONTRIBUTING.md).
# Anleitung zur Nutzung dieses Repositories für die Prototypherstellung
1. Lesen der README [Materialherstellung](mod/material_fabrication/README.md) zum grundlegenden Verständnis über den gesamten Prozess.
2. Lesen der README [Wachstumsform](mod/mould/README.md), [Befestigungssystem](mod/mounting_system/README.md) und [Anker](mod/anchor/README.md) zum Verständnis der weiteren Teilprozesse.
3. Entscheidung, welche Variante der Formherstellung je nach Budget und Stückzahl für dich geeignet ist. Für geringe Stückzahlen eignet sich der dirkekte 3D-Druck der Negativform. Für größere Stückzahlen eignet sich der 3D-Druck einiger Positivformen mit anschließender mehrfacher Abformung aus Gips.
4. Planung. Da der Pilz, wenn er einmal wächst sich mehr stoppen lässt, ist ein methodisches und vorrausschauendes Arbeiten notwendig. Die Herstellung der Wachstumsformen und Anker sollte als erstes geplant und entweder vor Beimpfung des Substrates mit Pilzmyzel durchgeführt werden oder soweit vorbereitet sein, dass deren Herstellung wenige Tage nach Beimpfung des Substrates abgeschlossen werden kann.
5. Sicherstellung der benötigten Geräte in örtlichen Fablabs und offenen Laboren.
6. Besorgung der benötigten Materialien.
1. Lesen Sie die README [Materialherstellung](mod/material_fabrication/README.md) zum grundlegenden Verständnis über den gesamten Prozess.
2. Lesen Sie die README [Wachstumsform](mod/mould/README.md), [Befestigungssystem](mod/mounting_system/README.md) und [Anker](mod/anchor/README.md) zum Verständnis der weiteren Teilprozesse.
3. Entscheidung Sie, welche Variante der Formherstellung je nach Budget und Stückzahl für dich geeignet ist. Für geringe Stückzahlen eignet sich der dirkekte 3D-Druck der Negativform. Für größere Stückzahlen eignet sich der 3D-Druck einiger Positivformen mit anschließender mehrfacher Abformung aus Gips.
4. Erstellen Sie einen Zeitplan. Da der Pilz, wenn er einmal wächst sich mehr stoppen lässt, ist ein methodisches und vorrausschauendes Arbeiten notwendig. Die Herstellung der Wachstumsformen und Anker sollte als erstes geplant und entweder vor Beimpfung des Substrates mit Pilzmyzel durchgeführt werden oder soweit vorbereitet sein, dass deren Herstellung wenige Tage nach Beimpfung des Substrates abgeschlossen werden kann.
5. Stellen Sie die benötigten Geräte in örtlichen Fablabs und offenen Laboren sicher.
6. Besorgen Sie die benötigten Materialien.
7. Jetzt kann der praktischen Teil beginnen.

11
doc/contributing/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,11 @@
# Contribution Guide: Akustikabsorber aus Pilzmyzelkompositmaterial
Vielen Dank, dass Sie Ihre Zeit investieren wollen, um zu unserem Projekt beizutragen. In diesem Leitfaden erhalten Sie einen Überblick, wie Sie an dem Projekt mitarbeiten können.
1. Forken Sie das Projekt auf Gitea und erstellen Sie einen neuen Branch für Ihre Änderungen.
2. Ändern Sie die Dokumentation und testen Sie Ihre Änderungen gründlich.
3. Erstellen Sie einen Pull Request (PR) in das originale Repository und beschreiben Sie kurz Ihre Änderungen und warum sie sinnvoll sind.
4. Warten Sie auf Feedback von den Projekt-Maintainern. Sie können ggf. gebeten werden, weitere Änderungen vorzunehmen, bevor Ihr PR angenommen wird.
5. Sobald Ihr PR angenommen wurde, wird Ihr Code Teil des Projekts und Sie werden als Contributor im Projekt gelistet.
Hinweis: Bitte stellen Sie sicher, dass Ihr Code den Standards des Projekts entspricht und die Lizenzbedingungen einhält, bevor Sie einen PR erstellen.

10
doc/usage/user_manual.md
View file

@ -8,11 +8,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0
## Gliederung
[1. Nutzen des Myzel Akustikabsorbers](#1.-nutzen-des-myzel-akustikabsorbers)
[2. Positionierung im Raum](#2-positionierung-im-raum)
[3. Positionierung im Raum](#3-umgebungsbedingung)
[4. Weitere Hinweise](#4-weitere-hinweise)
[5. Lizenz](#5-lizenz)
1. [Nutzen des Myzel Akustikabsorbers](#1.-nutzen-des-myzel-akustikabsorbers)
2. [Positionierung im Raum](#2-positionierung-im-raum)
3. [Positionierung im Raum](#3-umgebungsbedingung)
4. [Weitere Hinweise](#4-weitere-hinweise)
5. [Lizenz](#5-lizenz)
## 1. Nutzen des Myzel Akustikabsorbers