diff --git a/mod/unixish/definition.csv b/mod/unixish/definition.csv index accc6ec..791a2df 100644 --- a/mod/unixish/definition.csv +++ b/mod/unixish/definition.csv @@ -1,116 +1,116 @@ Path,Normative,Tracked,Generated,Module,ArbitraryContent,Tags,Indicativeness,Variations,Regex,Description,Sample Content -LICENSES/,true,true,false,false,false,,0.2,LICENSES,,REUSE license files (preferred over single LICENSE file), -LICENSES/AGPL-3.0-or-later.txt,false,true,false,false,-,license,0,,[^/]+\.txt,,https://www.gnu.org/licenses/agpl-3.0.txt -LICENSE.txt,true,true,false,false,-,license,0,,(?i)(LICEN[SC]E|COPYING)(\.[^/]+)?(\.(txt|md|rst))?,"Single, project-wide, generic license file (long term: deprecated)",https://www.gnu.org/licenses/agpl-3.0.txt -README.md,true,true,false,false,-,,0,,(?i)README(\.(txt|md|rst))?,,https://gitlab.com/OSEGermany/ohloom/-/raw/master/README.md -okh.toml,true,true,false,false,-,,0,,okh\.(toml|ya?ml|json|ttl|rdf),manually maintained Open Know-How OSH project manifest (= meta-data file) ValueFlows recipes,https://gitlab.com/OSEGermany/ohloom/-/raw/master/okh.toml -bom.csv,true,true,false,false,-,bom,0,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(csv|tsv),"manually maintained Bill of Materials. Usually, ""gen/bom.csv"" is preferred; though even better is the use of ValueFlows recipes (preferred format)",https://gitlab.com/OSEGermany/ohloom/-/raw/master/sBoM.csv -bom.csv.license,true,true,false,false,-,bom,0,,.+\.license,"REUSE *.license files - preferred over /.reuse/deb5, though header comments are preffered over this approach",https://raw.githubusercontent.com/hoijui/osh-dir-std/main/default_mod.csv.license -bom.ods,true,true,false,false,-,bom,0,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(ods),"manually maintained Bill of Materials. Usually, ""gen/bom.csv"" is preferred; though even better is the use of ValueFlows recipes (non-preferred format)",https://gitlab.fabcity.hamburg/hardware/interfacer-osh-build-workshops/libre-solar-box-360wh/-/raw/6a2a2e5d59f91672ed01129b7f8b91eee2715ba9/bom.ods?inline=false -assembly.vf_recipe.ttl,true,true,false,false,-,,0.3,,assembly\.vf_recipe\.ttl,ValueFlows assembling recipe, -manuf.vf_recipe.ttl,true,true,false,false,-,,0.3,,manu\.vf_recipe\.ttl,ValueFlows manufacturing recipe, -recycle.vf_recipe.ttl,true,true,false,false,-,,0.3,,recycle\.vf_recipe\.ttl,ValueFlows recycling recipe, -run/,true,true,false,false,true,,0.9,run|exec|scripts|bin,,"Project maintenance scripts, preferably platform independent", -run/build,true,true,false,false,-,,0.5,build,,"Creates all output, including generated files and archives",cd src/software/control_lib/; cargo build --release -run/clean,true,true,false,false,-,,0.5,clean,,Deletes all generated files, -run/test,true,true,false,false,-,,0.5,test,,"Runs potential unit- and integration tests, validation, linters and similar things", -run/release,true,true,false,false,-,,0.5,release,,"Creates a release for this project, including tagging and a release on the hosting platform, if any", -run/ci,true,true,false,false,-,,0.5,ci,,"Run by CI/Buildbot on each commit, but has to also be usable locally",apt-get install cargo; run/build -res/,true,true,false,false,false,,0.7,res|resource|resources,,"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/conf/,true,true,false,false,true,,0.3,conf|config|configuration,,"Configuration & settings files, e.g. 3D printer settings, log settings, ...", -res/conf/some-config.xml,false,true,false,false,-,,0,,.+\.xml,,https://raw.githubusercontent.com/xiaoxpai/mbp_first_code/master/mbp-struts2-spring-init/src/main/resources/log4j2.xml -res/conf/VisiCut-config.plf,false,true,false,false,-,,0,,.+\.plf,,https://gitlab.fabcity.hamburg/hardware/interfacer-osh-build-workshops/libre-solar-box-360wh/-/raw/6a2a2e5d59f91672ed01129b7f8b91eee2715ba9/res/conf/inner-plate-9mm_laser_visicut_config.plf?inline=false -res/media/,true,true,false,false,false,,0.6,med|media,,"Non-binary (and usually rather small) media goes here. Media are (mainly) images, audio recordings and videos.", -res/media/img/,true,true,false,false,true,,0.3,img|image|images,,Non-binary (and usually rather small) images go here., -res/media/img/diagram-1.svg,false,true,false,false,-,,0,,.+\.svg,,https://www.svgrepo.com/show/185/diagram.svg -res/assets/,true,true,true,false,false,,0.7,asset|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/,true,true,true,false,false,,0.6,med|media,,, -res/assets/media/img/,true,true,true,false,true,,0.3,img|image|images,,, -res/assets/media/img/drawing-1.png,false,true,true,false,-,,0,,.+\.a?png,,https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png -res/assets/media/img/animation-1.gif,false,true,true,false,-,,0,,.+\.gif,,https://upload.wikimedia.org/wikipedia/commons/2/2c/Rotating_earth_%28large%29.gif -res/assets/media/img/photo-1.jpg,false,true,true,false,-,,0,,.+\.jpe?g,,https://www.adslzone.net/app/uploads-adslzone.net/2021/11/todo-sobre-jpg-930x487.jpg -res/assets/media/img/photo-2.webp,false,true,true,false,-,,0,,.+\.(webp|avif),, -res/assets/media/img/partialy-auto-generated-drawing.pdf,false,true,true,false,-,,0,,.+\.pdf,, -res/assets/media/vid/,true,true,true,false,true,,0.3,vid|video|videos,,, -res/assets/media/vid/tutorial.webm,false,true,true,false,-,,0,,.+\.(webm|mp4),,https://file-examples.com/wp-content/uploads/2020/03/file_example_WEBM_480_900KB.webm -res/assets/var/,true,true,true,false,true,,0.5,var|various|misc|miscellaneous,,"Stands for ""various"", aka ""misc.""/""miscellaneous""; and should hold files that do not fit into any of the other resource categories.", -res/assets/var/datasheet-x.pdf,false,true,true,false,-,,0,,.+\.pdf,,https://www.infineon.com/dgdl/Infineon-IRS2304-DataSheet-v01_00-EN.pdf -src/,true,true,false,false,false,,0.7,src|source|sources,,"Source files - Editable files (Think: Word, not PDF)", -src/anim/,true,true,false,false,true,,0.4,anim|animation|animations,,Animation sources - The generated animations would usually serve documentation, -src/anim/assembly.blend,false,true,false,false,-,,0,,.+\.blend,Blender 3D source file,https://github.com/PacktPublishing/Blender-3D-Modeling-and-Animation-Build-20-3D-Projects-in-Blender/blob/master/CODES/Project%2010%20-%20Box%20animation/boxOpenCourse.blend?raw=true -src/calc/,true,true,false,false,true,,0.4,calc|calculation|calculations,,Calculation sources, -src/calc/required-material-thickness.m,false,true,false,false,-,,0,,.+\.m,Octave (or Matlab) calculations file,https://github.com/mathworks-robotics/trajectory-planning-robot-manipulators/raw/master/startupExample.m -src/calc/feedback-evaluation.ods,false,true,false,false,-,,0,,.+\.(ods|xlsx),LibreOffice spread-sheet/table file with calculations,https://github.com/miachm/SODS/blob/master/resources/floatfontsize.ods?raw=true -src/sim/,true,true,false,false,true,,0.4,sim|simulation|simulations,,Simulation sources, -src/sim/stress-test.OpenFOAM,false,true,false,false,-,,0,,.+\.OpenFOAM,,https://github.com/alda30/OpenFoam-examples/blob/master/(01)cavity/0/U -src/elec/,true,true,false,false,true,,0.8,el|elec|electronic|electronics,,"Electronic ""blueprints"" - Schemas & PCBs", -src/elec/main.pro,false,true,false,false,-,,0,,.+\.pro,KiCad project file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro -src/elec/main.sch,false,true,false,false,-,,0,,.+\.sch,KiCad schematics file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch -src/elec/main.kicad_pcb,false,true,false,false,-,,0,,.+\.kicad_pcb,KiCad PCB file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb -src/elec/plate.pro,false,true,false,false,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro -src/elec/plate.sch,false,true,false,false,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch -src/elec/plate.kicad_pcb,false,true,false,false,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb -src/elec/main-subs/,false,true,false,false,true,,0,,.+/,"Electronic ""blueprints"" arbitrary sub-dir", -src/elec/main-subs/sub-a.pro,false,true,false,false,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro -src/elec/main-subs/sub-a.sch,false,true,false,false,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch -src/elec/main-subs/sub-a.kicad_pcb,false,true,false,false,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb -src/elec/main-subs/sub-b.pro,false,true,false,false,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro -src/elec/main-subs/sub-b.sch,false,true,false,false,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch -src/elec/main-subs/sub-b.kicad_pcb,false,true,false,false,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb -src/elec/main-subs/parts.lib,false,true,false,false,-,,0,,.+\.lib,KiCad parts library, -src/firmware/,true,true,false,false,true,,0.4,fw|firm|firmware,,Firmware sources, -src/firmware/Makefile,false,true,false,false,-,,0,,(.+/)?Makefile|CMakeLists.txt,, -src/firmware/main.c,false,true,false,false,-,,0,,.+\.c,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/ipip.c -src/firmware/other.h,false,true,false,false,-,,0,,.+\.h,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/ipip.h -src/firmware/other.c,false,true,false,false,-,,0,,.+\.c,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/test.c -src/mech/,true,true,false,false,true,,0.8,mec|mech|mechanic|mechanics|mechanical,,"Mechanical ""blueprints"" - Computer Aided Design (CAD) files", -src/mech/case.fcstd,false,true,false,false,-,,0,,.+\.fcstd,FreeCAD project,https://github.com/case06/ZACplus/blob/master/cadfiles/kammer/kammer_00.fcstd?raw=true -src/mech/case-alternative.fcstd,false,true,false,false,-,,0,,.+\.FCStd,FreeCAD project,https://github.com/case06/ZACplus/blob/master/cadfiles/kammer/kammer_01.fcstd?raw=true -src/mech/parts.lib,false,true,false,false,-,,0,,.+\.lib,FreeCAD parts library, -src/mech/pieceX.scad,false,true,false,false,-,,0,,.+\.scad,OpenSCAD source file - Open Source CAD defined in code,https://gitlab.com/OSEGermany/ohloom/-/raw/master/3DParts/PoleBase/PoleBase.scad -src/software/,true,true,false,false,true,,0.4,sw|sftw|software,,Firmware sources, -src/software/control_lib/Cargo.toml,false,true,false,false,-,,0,,(.+/)?Cargo\.toml|pom\.xml,A sample Rust Software - Project file,https://github.com/hoijui/mle/raw/develop/Cargo.toml -src/software/control_lib/src/main.rs,false,true,false,false,-,,0,,.+\.(rs|cpp|java|py),A sample Rust Software - Source file,https://github.com/hoijui/mle/raw/develop/src/main.rs -src/test/,true,true,false,false,true,,0.3,tst|test|tests,,Sources for unit- and integration tests for anything contained in this project (excluding the inner details of sub-modules), -gen/,true,false,true,false,false,,0.1,bld|build|target|out|output|gen|generated|untracked|exp|export|exports|exported,,Where everything generated should en up; this is not tracked in git/SCM, -gen/assembly.vf_recipe.ttl,true,false,true,false,-,,0.3,,assembly\.vf_recipe\.ttl,"alternative location, if generated - ValueFlows assembling recipe", -gen/manuf.vf_recipe.ttl,true,false,true,false,-,,0.3,,manuf\.vf_recipe\.ttl,, -gen/recycle.vf_recipe.ttl,true,false,true,false,-,,0.3,,recycle\.vf_recipe\.ttl,, -gen/okh.toml,true,false,true,false,-,,0.2,,okh\.(toml|ya?ml|json|ttl|rdf),"alternative location, if generated", -gen/bom.csv,true,false,true,false,-,bom,0.2,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(csv|tsv),"alternative location, if generated", -gen/site/,true,false,true,false,true,,0.2,site|public,,"Generated website of the project (for example, for hosting on github or gitlab pages)", -gen/anim/,true,false,true,false,true,,0.4,anim|animation|animations,,, -gen/calc/,true,false,true,false,true,,0.4,calc|calculation|calculations,,, -gen/sim/,true,false,true,false,true,,0.4,sim|simulation|simulations,,, -gen/software/,true,false,true,false,true,,0.4,sw|sftw|software,,, -gen/firmware/,true,false,true,false,true,,0.4,fw|firm|firmware,,, -gen/elec/,true,false,true,false,true,,0.4,el|elec|electronic|electronics,,, -gen/mech/,true,false,true,false,true,,0.4,mec|mech|mechanic|mechanics|mechanical,,, -gen/doc/,true,false,true,false,false,,0.4,doc|docs|docu|documentation,,, -gen/doc/assembly/,true,false,true,false,true,,0.5,ass|asmbly|assembly,,, -gen/doc/manuf/,true,false,true,false,true,,0.5,man|manu|manuf|manufac|manufact|manufacturing,,, -gen/doc/usr/,true,false,true,false,true,,0.5,usr|user,,, -gen/doc/recycling/,true,false,true,false,true,,0.5,rec|recycle|recycling,,, -doc/,true,true,false,false,false,,0.3,doc|docs|docu|documentation,,"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).", -doc/assembly/,true,true,false,false,true,,0.5,ass|asmbly|assembly,,"Assembly instructions manual sources - Assembly means: You have all the parts available (bought, printed, milled, ...), and now want to put them together. So this is like a LEGO or IKEA manual. See also: doc/manuf/.", -doc/assembly/vf_recipe.ttl,true,true,false,false,-,,0.3,,vf_recipe\.ttl,alternative location 2 - ValueFlows assembling recipe, -doc/assembly/main.md,false,true,false,false,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) -doc/assembly/chap-1/sec-1.md,false,true,false,false,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/drawing-1.png) -doc/assembly/chap-1/sec-2.md,false,true,false,false,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) -doc/manuf/,true,true,false,false,true,,0.5,man|manu|manuf|manufac|manufact|manufacturing,,"Manufacturing instructions manual sources - Manufacturing means: Details about how to get from the sources under src/elec/ and src/mech/ to the actual parts, so this contains the meta-data about, and describes the process of 3D-printing, milling, carving, ... the individual parts. See also: doc/assembly/.", -doc/manuf/main.md,false,true,false,false,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) -doc/manuf/chap-1/sec-1.md,false,true,false,false,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) -doc/manuf/chap-1/sec-2.md,false,true,false,false,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/animation-1.gif) -doc/usr/,true,true,false,false,true,,0.5,usr|user|usage,,"User manual (aka operation, repair & maintenance instructions -> split up?) sources", -doc/usr/main.md,false,true,false,false,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) -doc/usr/chap-1/sec-1.md,false,true,false,false,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/drawing-1.png) -doc/usr/chap-1/sec-2.md,false,true,false,false,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) -doc/recycling/,true,true,false,false,true,,0.5,rec|recycle|recycling,,Recycling instructions sources, -doc/recycling/main.md,false,true,false,false,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) -doc/recycling/chap-1/sec-1.md,false,true,false,false,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) -doc/recycling/chap-1/sec-2.md,false,true,false,false,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/animation-1.gif) -doc/workshops/,true,true,false,false,true,,0.5,ws|workshop|workshops,,Contains arbitrarily named dirs that each contains a workshop documentation, -doc/workshops/build/main.md,false,true,false,false,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) -mod/,true,true,false,false,false,,0.9,mod|module|modules,,"Modules - In here might be git sub-modules or not, but either way, they have to follow the same dir structure as the main project", -mod/module-a/,false,true,false,true,false,,0,,[^/]+,, -mod/module-b/,false,true,false,true,false,,0,,[^/]+,, +assembly.vf_recipe.ttl,TRUE,TRUE,FALSE,FALSE,-,,0.3,,assembly\.vf_recipe\.ttl,ValueFlows assembling recipe, +bom.csv,TRUE,TRUE,FALSE,FALSE,-,bom,0,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(csv|tsv),"manually maintained Bill of Materials. Usually, ""gen/bom.csv"" is preferred; though even better is the use of ValueFlows recipes (preferred format)",https://gitlab.com/OSEGermany/ohloom/-/raw/master/sBoM.csv +bom.csv.license,TRUE,TRUE,FALSE,FALSE,-,bom,0,,.+\.license,"REUSE *.license files - preferred over /.reuse/deb5, though header comments are preffered over this approach",https://raw.githubusercontent.com/hoijui/osh-dir-std/main/default_mod.csv.license +bom.ods,TRUE,TRUE,FALSE,FALSE,-,bom,0,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(ods),"manually maintained Bill of Materials. Usually, ""gen/bom.csv"" is preferred; though even better is the use of ValueFlows recipes (non-preferred format)",https://gitlab.fabcity.hamburg/hardware/interfacer-osh-build-workshops/libre-solar-box-360wh/-/raw/6a2a2e5d59f91672ed01129b7f8b91eee2715ba9/bom.ods?inline=false +doc/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.3,doc|docs|docu|documentation,,"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).", +doc/assembly/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.5,ass|asmbly|assembly,,"Assembly instructions manual sources - Assembly means: You have all the parts available (bought, printed, milled, ...), and now want to put them together. So this is like a LEGO or IKEA manual. See also: doc/manuf/.", +doc/assembly/chap-1/sec-1.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/drawing-1.png) +doc/assembly/chap-1/sec-2.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) +doc/assembly/main.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) +doc/assembly/vf_recipe.ttl,TRUE,TRUE,FALSE,FALSE,-,,0.3,,vf_recipe\.ttl,alternative location 2 - ValueFlows assembling recipe, +doc/manuf/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.5,man|manu|manuf|manufac|manufact|manufacturing,,"Manufacturing instructions manual sources - Manufacturing means: Details about how to get from the sources under src/elec/ and src/mech/ to the actual parts, so this contains the meta-data about, and describes the process of 3D-printing, milling, carving, ... the individual parts. See also: doc/assembly/.", +doc/manuf/chap-1/sec-1.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) +doc/manuf/chap-1/sec-2.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/animation-1.gif) +doc/manuf/main.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) +doc/recycling/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.5,rec|recycle|recycling,,Recycling instructions sources, +doc/recycling/chap-1/sec-1.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) +doc/recycling/chap-1/sec-2.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/animation-1.gif) +doc/recycling/main.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) +doc/usr/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.5,usr|user|usage,,"User manual (aka operation, repair & maintenance instructions -> split up?) sources", +doc/usr/chap-1/sec-1.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image X](../../../res/assets/media/img/drawing-1.png) +doc/usr/chap-1/sec-2.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) +doc/usr/main.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,[C1 S1](chap-1/sec-1.md) [C1 S2](chap-1/sec-2.md) +doc/workshops/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.5,ws|workshop|workshops,,Contains arbitrarily named dirs that each contains a workshop documentation, +doc/workshops/build/main.md,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.md,,![image Y](../../../res/media/img/diagram-1.svg) +gen/,TRUE,FALSE,TRUE,FALSE,FALSE,,0.1,bld|build|target|out|output|gen|generated|untracked|exp|export|exports|exported,,Where everything generated should en up; this is not tracked in git/SCM, +gen/anim/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,anim|animation|animations,,, +gen/assembly.vf_recipe.ttl,TRUE,FALSE,TRUE,FALSE,-,,0.3,,assembly\.vf_recipe\.ttl,"alternative location, if generated - ValueFlows assembling recipe", +gen/bom.csv,TRUE,FALSE,TRUE,FALSE,-,bom,0.2,,([bB][oO][mM]|[bB]ill_?[oO]f_?[mM]aterials)\.(csv|tsv),"alternative location, if generated", +gen/calc/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,calc|calculation|calculations,,, +gen/doc/,TRUE,FALSE,TRUE,FALSE,FALSE,,0.4,doc|docs|docu|documentation,,, +gen/doc/assembly/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.5,ass|asmbly|assembly,,, +gen/doc/manuf/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.5,man|manu|manuf|manufac|manufact|manufacturing,,, +gen/doc/recycling/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.5,rec|recycle|recycling,,, +gen/doc/usr/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.5,usr|user,,, +gen/elec/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,el|elec|electronic|electronics,,, +gen/firmware/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,fw|firm|firmware,,, +gen/manuf.vf_recipe.ttl,TRUE,FALSE,TRUE,FALSE,-,,0.3,,manuf\.vf_recipe\.ttl,, +gen/mech/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,mec|mech|mechanic|mechanics|mechanical,,, +gen/okh.toml,TRUE,FALSE,TRUE,FALSE,-,,0.2,,okh\.(toml|ya?ml|json|ttl|rdf),"alternative location, if generated", +gen/recycle.vf_recipe.ttl,TRUE,FALSE,TRUE,FALSE,-,,0.3,,recycle\.vf_recipe\.ttl,, +gen/sim/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,sim|simulation|simulations,,, +gen/site/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.2,site|public,,"Generated website of the project (for example, for hosting on github or gitlab pages)", +gen/software/,TRUE,FALSE,TRUE,FALSE,TRUE,,0.4,sw|sftw|software,,, +LICENSE.txt,TRUE,TRUE,FALSE,FALSE,-,license,0,,(?i)(LICEN[SC]E|COPYING)(\.[^/]+)?(\.(txt|md|rst))?,"Single, project-wide, generic license file (long term: deprecated)",https://www.gnu.org/licenses/agpl-3.0.txt +LICENSES/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.2,LICENSES,,REUSE license files (preferred over single LICENSE file), +LICENSES/AGPL-3.0-or-later.txt,FALSE,TRUE,FALSE,FALSE,-,license,0,,[^/]+\.txt,,https://www.gnu.org/licenses/agpl-3.0.txt +manuf.vf_recipe.ttl,TRUE,TRUE,FALSE,FALSE,-,,0.3,,manu\.vf_recipe\.ttl,ValueFlows manufacturing recipe, +mod/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.9,mod|module|modules,,"Modules - In here might be git sub-modules or not, but either way, they have to follow the same dir structure as the main project", +mod/module-a/,FALSE,TRUE,FALSE,TRUE,FALSE,,0,,[^/]+,, +mod/module-b/,FALSE,TRUE,FALSE,TRUE,FALSE,,0,,[^/]+,, +okh.toml,TRUE,TRUE,FALSE,FALSE,-,,0,,okh\.(toml|ya?ml|json|ttl|rdf),manually maintained Open Know-How OSH project manifest (= meta-data file) ValueFlows recipes,https://gitlab.com/OSEGermany/ohloom/-/raw/master/okh.toml +README.md,TRUE,TRUE,FALSE,FALSE,-,,0,,(?i)README(\.(txt|md|rst))?,,https://gitlab.com/OSEGermany/ohloom/-/raw/master/README.md +recycle.vf_recipe.ttl,TRUE,TRUE,FALSE,FALSE,-,,0.3,,recycle\.vf_recipe\.ttl,ValueFlows recycling recipe, +res/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.7,res|resource|resources,,"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/,TRUE,TRUE,TRUE,FALSE,FALSE,,0.7,asset|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/,TRUE,TRUE,TRUE,FALSE,FALSE,,0.6,med|media,,, +res/assets/media/img/,TRUE,TRUE,TRUE,FALSE,TRUE,,0.3,img|image|images,,, +res/assets/media/img/animation-1.gif,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.gif,,https://upload.wikimedia.org/wikipedia/commons/2/2c/Rotating_earth_%28large%29.gif +res/assets/media/img/drawing-1.png,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.a?png,,https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png +res/assets/media/img/partialy-auto-generated-drawing.pdf,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.pdf,, +res/assets/media/img/photo-1.jpg,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.jpe?g,,https://www.adslzone.net/app/uploads-adslzone.net/2021/11/todo-sobre-jpg-930x487.jpg +res/assets/media/img/photo-2.webp,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.(webp|avif),, +res/assets/media/vid/,TRUE,TRUE,TRUE,FALSE,TRUE,,0.3,vid|video|videos,,, +res/assets/media/vid/tutorial.webm,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.(webm|mp4),,https://file-examples.com/wp-content/uploads/2020/03/file_example_WEBM_480_900KB.webm +res/assets/var/,TRUE,TRUE,TRUE,FALSE,TRUE,,0.5,var|various|misc|miscellaneous,,"Stands for ""various"", aka ""misc.""/""miscellaneous""; and should hold files that do not fit into any of the other resource categories.", +res/assets/var/datasheet-x.pdf,FALSE,TRUE,TRUE,FALSE,-,,0,,.+\.pdf,,https://www.infineon.com/dgdl/Infineon-IRS2304-DataSheet-v01_00-EN.pdf +res/conf/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.3,conf|config|configuration,,"Configuration & settings files, e.g. 3D printer settings, log settings, ...", +res/conf/VisiCut-config.plf,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.plf,,https://gitlab.fabcity.hamburg/hardware/interfacer-osh-build-workshops/libre-solar-box-360wh/-/raw/6a2a2e5d59f91672ed01129b7f8b91eee2715ba9/res/conf/inner-plate-9mm_laser_visicut_config.plf?inline=false +res/conf/some-config.xml,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.xml,,https://raw.githubusercontent.com/xiaoxpai/mbp_first_code/master/mbp-struts2-spring-init/src/main/resources/log4j2.xml +res/media/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.6,med|media,,"Non-binary (and usually rather small) media goes here. Media are (mainly) images, audio recordings and videos.", +res/media/img/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.3,img|image|images,,Non-binary (and usually rather small) images go here., +res/media/img/diagram-1.svg,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.svg,,https://www.svgrepo.com/show/185/diagram.svg +run/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.9,run|exec|scripts|bin,,"Project maintenance scripts, preferably platform independent", +run/build,TRUE,TRUE,FALSE,FALSE,-,,0.5,build,,"Creates all output, including generated files and archives",cd src/software/control_lib/; cargo build --release +run/ci,TRUE,TRUE,FALSE,FALSE,-,,0.5,ci,,"Run by CI/Buildbot on each commit, but has to also be usable locally",apt-get install cargo; run/build +run/clean,TRUE,TRUE,FALSE,FALSE,-,,0.5,clean,,Deletes all generated files, +run/release,TRUE,TRUE,FALSE,FALSE,-,,0.5,release,,"Creates a release for this project, including tagging and a release on the hosting platform, if any", +run/test,TRUE,TRUE,FALSE,FALSE,-,,0.5,test,,"Runs potential unit- and integration tests, validation, linters and similar things", +src/,TRUE,TRUE,FALSE,FALSE,FALSE,,0.7,src|source|sources,,"Source files - Editable files (Think: Word, not PDF)", +src/anim/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.4,anim|animation|animations,,Animation sources - The generated animations would usually serve documentation, +src/anim/assembly.blend,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.blend,Blender 3D source file,https://github.com/PacktPublishing/Blender-3D-Modeling-and-Animation-Build-20-3D-Projects-in-Blender/blob/master/CODES/Project%2010%20-%20Box%20animation/boxOpenCourse.blend?raw=true +src/calc/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.4,calc|calculation|calculations,,Calculation sources, +src/calc/feedback-evaluation.ods,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.(ods|xlsx),LibreOffice spread-sheet/table file with calculations,https://github.com/miachm/SODS/blob/master/resources/floatfontsize.ods?raw=true +src/calc/required-material-thickness.m,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.m,Octave (or Matlab) calculations file,https://github.com/mathworks-robotics/trajectory-planning-robot-manipulators/raw/master/startupExample.m +src/elec/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.8,el|elec|electronic|electronics,,"Electronic ""blueprints"" - Schemas & PCBs", +src/elec/main-subs/,FALSE,TRUE,FALSE,FALSE,TRUE,,0,,.+/,"Electronic ""blueprints"" arbitrary sub-dir", +src/elec/main-subs/parts.lib,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.lib,KiCad parts library, +src/elec/main-subs/sub-a.kicad_pcb,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb +src/elec/main-subs/sub-a.pro,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro +src/elec/main-subs/sub-a.sch,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch +src/elec/main-subs/sub-b.kicad_pcb,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb +src/elec/main-subs/sub-b.pro,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro +src/elec/main-subs/sub-b.sch,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch +src/elec/main.kicad_pcb,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.kicad_pcb,KiCad PCB file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb +src/elec/main.pro,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.pro,KiCad project file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro +src/elec/main.sch,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.sch,KiCad schematics file,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch +src/elec/plate.kicad_pcb,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.kicad_pcb,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.kicad_pcb +src/elec/plate.pro,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.pro,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.pro +src/elec/plate.sch,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.sch,,https://github.com/KarlK90/yaemk-split-kb/raw/main/PCB/YAEMK.sch +src/firmware/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.4,fw|firm|firmware,,Firmware sources, +src/firmware/Makefile,FALSE,TRUE,FALSE,FALSE,-,,0,,(.+/)?Makefile|CMakeLists.txt,, +src/firmware/main.c,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.c,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/ipip.c +src/firmware/other.c,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.c,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/test.c +src/firmware/other.h,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.h,,https://github.com/17mon/c/raw/f5527adc90e8144f0adf9b19bca00b39489fa345/datx/ipip.h +src/mech/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.8,mec|mech|mechanic|mechanics|mechanical,,"Mechanical ""blueprints"" - Computer Aided Design (CAD) files", +src/mech/case-alternative.fcstd,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.FCStd,FreeCAD project,https://github.com/case06/ZACplus/blob/master/cadfiles/kammer/kammer_01.fcstd?raw=true +src/mech/case.fcstd,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.fcstd,FreeCAD project,https://github.com/case06/ZACplus/blob/master/cadfiles/kammer/kammer_00.fcstd?raw=true +src/mech/parts.lib,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.lib,FreeCAD parts library, +src/mech/pieceX.scad,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.scad,OpenSCAD source file - Open Source CAD defined in code,https://gitlab.com/OSEGermany/ohloom/-/raw/master/3DParts/PoleBase/PoleBase.scad +src/sim/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.4,sim|simulation|simulations,,Simulation sources, +src/sim/stress-test.OpenFOAM,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.OpenFOAM,,https://github.com/alda30/OpenFoam-examples/blob/master/(01)cavity/0/U +src/software/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.4,sw|sftw|software,,Firmware sources, +src/software/control_lib/Cargo.toml,FALSE,TRUE,FALSE,FALSE,-,,0,,(.+/)?Cargo\.toml|pom\.xml,A sample Rust Software - Project file,https://github.com/hoijui/mle/raw/develop/Cargo.toml +src/software/control_lib/src/main.rs,FALSE,TRUE,FALSE,FALSE,-,,0,,.+\.(rs|cpp|java|py),A sample Rust Software - Source file,https://github.com/hoijui/mle/raw/develop/src/main.rs +src/test/,TRUE,TRUE,FALSE,FALSE,TRUE,,0.3,tst|test|tests,,Sources for unit- and integration tests for anything contained in this project (excluding the inner details of sub-modules),