doc/README.md

@@ -1,10 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. <akustik-absorber@curious.bio>
-
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# README `doc/`
-
-Documentation sources - How to use, build, repair, ... the piece of hardware described by the project. Below here, there should only be Markdown files (*maybe* also ValueFlows recipes).
-

okh.toml

@@ -8,61 +8,62 @@ repo = "https://code.curious.bio/curious.bio/myzel-akustikabsorber.git"
 license = "CC-BY-SA-4.0"
 licensor = "Curious Community Labs e. V."
 organisation = "Curious Community Labs e. V."
-readme = "/README.md"
-image = "/res/assets/media/img/FC5-Render-preview.webp"
+readme = "README.md"
+image = "res/assets/media/img/FC5-Render-preview.webp"
 documentation-language = "de"
 technology-readiness-level = "OTRL-3"
 documentation-readiness-level = "ODRL-2"
 function = "A prototype of an acoustic absorber made from mycelium composite material using organic residue"
-user-manual = "/mod/README.md"
-source = [ "/src/mech" ]
-bom = "/bom.csv"
+user-manual = "mod/README.md"
+source = [ "src/mech" ]
+bom = "bom.csv"
 tsdc = [ "3DP", "LAS", "ASM" ]
 
 [[part]]
 name = "4_piece_negative_mould"
-image = "/mod/mould/direct_3D_negative_mould/res/assets/media/img/mould_3d_parts.webp
+image = "mod/mould/direct_3D_negative_mould/res/assets/media/img/mould_3d_parts.webp"
 tsdc = "3DP"
-source = "/mod/mould/direct_3D_negative_mould/src/mech/pieceX.scad"
+source = "mod/mould/direct_3D_negative_mould/src/mech/pieceX.scad"
 export = [
-  "/mod/mould/direct_3D_negative_mould/src/mech/Negative-1-4-FC-5.4-Ultimaker.stl",
-  "/mod/mould/direct_3D_negative_mould/src/mech/Negative-2-4-FC-5.4-Ultimaker.stl",
-  "/mod/mould/direct_3D_negative_mould/src/mech/Negative-3-4-FC-5.4-Ultimaker.stl",
-  "/mod/mould/direct_3D_negative_mould/src/mech/Negative-4-4-FC-5.4-Ultimaker.stl",
+  "mod/mould/direct_3D_negative_mould/src/mech/Negative-1-4-FC-5.4-Ultimaker.stl",
+  "mod/mould/direct_3D_negative_mould/src/mech/Negative-2-4-FC-5.4-Ultimaker.stl",
+  "mod/mould/direct_3D_negative_mould/src/mech/Negative-3-4-FC-5.4-Ultimaker.stl",
+  "mod/mould/direct_3D_negative_mould/src/mech/Negative-4-4-FC-5.4-Ultimaker.stl",
 ]
 printing-process = "FDM"
-material = "ABS" ???
-infill = 30 ???
-raft-brim = true ???
-supports = false ???
-resolution-mm = 0.2 ???
-shell-thickness = 3 ???
-top-bottom-thickness = 3 ???
+material = "ABS" # TODO
+infill = 30 # TODO
+raft-brim = true # TODO
+supports = false # TODO
+resolution-mm = 0.2 # TODO
+shell-thickness = 3 # TODO
+top-bottom-thickness = 3 # TODO
 
-[[part.outer-dimensions]]
-openSCAD = "cylinder(h=30, r=28)" ???
-unit = "mm" ???
+[part.outer-dimensions]
+openSCAD = "cylinder(h=30, r=28)" # TODO
+unit = "mm" # TODO
 
-[[part.mass]]
-value = 30 ???
-unit = "g" ???
+[part.mass]
+value = 30 # TODO
+unit = "g" # TODO
 
-<!-- Hier stehen gesammelte Beispiele für Part-Metadaten. alles mit "???" muss noch überarbeitet werden.
+# Hier stehen gesammelte Beispiele für Part-Metadaten.
+# Alles mit `TODO` muss noch überarbeitet werden.
 
-[[outer-dimensions]]
+[outer-dimensions]
 openSCAD = "cube(size = [400,350,150])"
 unit = "mm"
 
-/mod/mould/casting_from_3D_positive_mould/src/mech/Positiv-1-4-FC-5.4-Ultimake...
+# Von /mod/mould/casting_from_3D_positive_mould/src/mech/Positiv-1-4-FC-5.4-Ultimake...
 
 [[part]]
 name = "direct_3D_negative_mould"
-image = "/mod/mould/direct_3D_negative_mould/res/assets/media/img/mould_3d_parts.webp"
+image = "mod/mould/direct_3D_negative_mould/res/assets/media/img/mould_3d_parts.webp"
 tsdc = "3DP"
-source = "/3DParts/ClampRing/ClampRing.scad"
+source = "3DParts/ClampRing/ClampRing.scad"
 export = [
-  "/3DParts/ClampRing/ClampRing.pdf",
-  "/3DParts/ClampRing/ClampRing.stl"
+  "3DParts/ClampRing/ClampRing.pdf",
+  "3DParts/ClampRing/ClampRing.stl"
 ]
 printing-process = "FDM"
 material = "ABS"
@@ -73,21 +74,19 @@ resolution-mm = 0.2
 shell-thickness = 3
 top-bottom-thickness = 3
 
-[[part.outer-dimensions]]
+[part.outer-dimensions]
 openSCAD = "cylinder(h=30, r=28)"
 unit = "mm"
 
-[[part.mass]]
+[part.mass]
 value = 30
 unit = "g"
 
 [[part]]
 name = "PlanktoScope-Case"
-image = "/doc/images/hardware/planktoscope_case_00.png"
+image = "doc/images/hardware/planktoscope_case_00.png"
 tsdc = "CNC"
-source = "/hardware/case/PlanktoScope-Case.f3z"
-export = ["/hardware/case/PlanktoScope-Case.dxf"]
+source = "hardware/case/PlanktoScope-Case.f3z"
+export = ["hardware/case/PlanktoScope-Case.dxf"]
 outer-dimension-dim = "mm"
 outer-dimension = "cube(size = [350,150,150])"
-
--->

res/README.md

@@ -1,10 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. <akustik-absorber@curious.bio>
-
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# README `res/`
-
-Stands for "resources", and should hold any files that are part of the sources of the project, but are not source code, design, scripts or documentation text files. This includes also binary files, next to text files. The sub-dirs within res/assets/ and res/ should be the same (excluding of course res/assets/assets/).
-

res/assets/README.md

@@ -1,10 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. <akustik-absorber@curious.bio>
-
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# README `res/assets/`
-
-All binary (and potentially large text-)resources should go here, as this allows to go "clean-slate" with this data from time to time, to reduce clone size, if done as a git sub-module (which can also be done later). Having it as a git sub-module, also allows to not fetch it at all, if storage or bandwidth is an issue, and it is not required for the task at hand. The sub-dirs within res/assets/ and res/ should be the same (excluding of course res/assets/assets/).
-

res/assets/media/README.md

@@ -1,10 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. <akustik-absorber@curious.bio>
-
-SPDX-License-Identifier: CC-BY-SA-4.0
--->
-
-# README `res/assets/media/`
-
-null
-