Kelder
/
obus
26
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Add documentation for needy finetuner

This commit is contained in:
Midgard 2022-03-18 00:08:58 +01:00
parent 8c09ca0d10
commit 2d21884f37
Signed by: midgard
GPG Key ID: 511C112F1331BBB4
4 changed files with 159 additions and 226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/needy_finetuner/face.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

155
docs/images/needy_finetuner/face.svg Normal file
View File

@ -0,0 +1,155 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="40mm"
height="32mm"
viewBox="0 0 40 32"
version="1.1"
id="svg5"
inkscape:version="1.1 (c68e22c387, 2021-05-23)"
sodipodi:docname="face.svg"
inkscape:export-filename="face.png"
inkscape:export-xdpi="96"
inkscape:export-ydpi="96"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview7"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="1"
inkscape:pagecheckerboard="0"
inkscape:document-units="mm"
showgrid="false"
width="4mm"
showguides="true"
inkscape:guide-bbox="true"
inkscape:zoom="4.4408201"
inkscape:cx="54.269255"
inkscape:cy="63.276601"
inkscape:window-width="1920"
inkscape:window-height="1038"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1"
inkscape:current-layer="layer1"
inkscape:snap-global="true">
<sodipodi:guide
position="19.999999,31.999999"
orientation="-1,0"
id="guide9"
inkscape:label=""
inkscape:locked="false"
inkscape:color="rgb(0,0,255)" />
<sodipodi:guide
position="0,2.9999999"
orientation="0,1"
id="guide11"
inkscape:label=""
inkscape:locked="false"
inkscape:color="rgb(0,0,255)" />
<sodipodi:guide
position="28.336657,20.053439"
orientation="0,-1"
id="guide1042" />
<sodipodi:guide
position="0,31.999999"
orientation="0,151.1811"
id="guide8477" />
<sodipodi:guide
position="39.999999,31.999999"
orientation="120.94488,0"
id="guide8479" />
<sodipodi:guide
position="39.999999,0"
orientation="0,-151.1811"
id="guide8481" />
<sodipodi:guide
position="0,0"
orientation="-120.94488,0"
id="guide8483" />
</sodipodi:namedview>
<defs
id="defs2">
<inkscape:path-effect
effect="powerstroke"
id="path-effect2314"
is_visible="true"
lpeversion="1"
offset_points="0.0032727661,0.13728877 | 0.10203782,0.2296437 | 0.78316682,0.085165578"
not_jump="false"
sort_points="true"
interpolator_type="CentripetalCatmullRom"
interpolator_beta="0.2"
start_linecap_type="butt"
linejoin_type="round"
miter_limit="4"
scale_width="1"
end_linecap_type="zerowidth" />
</defs>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1">
<path
style="fill:none;stroke:#111166;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="path35"
sodipodi:type="arc"
sodipodi:cx="20.000002"
sodipodi:cy="29.000002"
sodipodi:rx="22.397001"
sodipodi:ry="22.397001"
sodipodi:start="4.0101511"
sodipodi:end="5.4155569"
sodipodi:open="true"
sodipodi:arc-type="arc"
d="m 5.5331584,11.902163 a 22.397001,22.397001 0 0 1 28.9495826,0.01346" />
<rect
style="fill:#121265;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;fill-opacity:1"
id="rect3123"
width="2.2385232"
height="0.21232237"
x="7.9968696"
y="5.9020486" />
<path
style="fill:none;stroke:#111166;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 19.999999,6.5929498 V 5.1845484"
id="path1649" />
<path
id="rect1848"
style="fill:#121265;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none;fill-opacity:1"
d="m 29.224626,4.8891073 v 1.0128581 h -1.013375 v 0.21239 h 1.013375 v 1.0128581 h 0.211873 V 6.1143554 h 1.013376 v -0.21239 H 29.436499 V 4.8891073 Z" />
<path
style="fill:none;stroke:#666666;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="M 20.004398,28.99204 16.332851,11.933555"
id="path882"
inkscape:transform-center-x="2.5554827"
inkscape:transform-center-y="-12.041833"
sodipodi:nodetypes="cc" />
<rect
style="fill:#e6e6e6;stroke-width:0.2;stroke-linecap:round;fill-opacity:0.85464597"
id="rect986"
width="39.797634"
height="10.315113"
x="0"
y="21.47426" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 0.20236332,0.21062492 V 31.789374 H 39.797637 V 0.21062492 Z"
id="path8485" />
<path
style="fill:#ff482d;fill-rule:nonzero;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m 16.467066,11.904667 c -8.28e-4,-0.0038 -0.003,-0.0099 -0.005,-0.0231 -0.0108,-0.07261 -0.0039,-0.375401 -0.05976,-0.716566 C 16.256224,10.272588 15.523505,7.5331299 15.226306,6.387653 15.058533,5.7410143 14.882409,5.1271558 14.81363,4.8750564 c 0.04103,0.2580728 0.133044,0.8900338 0.246159,1.5484368 0.200375,1.1663163 0.65957,3.9646458 0.893541,4.8381488 0.08945,0.333936 0.2203,0.607074 0.240334,0.6777 0.0036,0.0128 0.0041,0.01925 0.005,0.0231 z"
inkscape:transform-center-x="2.5554827"
inkscape:transform-center-y="-12.041833"
sodipodi:nodetypes="cc"
inkscape:path-effect="#path-effect2314"
inkscape:original-d="M 16.332851,11.933555 14.81363,4.8750564"
id="path3154" />
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 5.8 KiB

209
src/modules/needy_finetuner/doc/face.svg
View File

@ -1,209 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="40mm"
height="32mm"
viewBox="0 0 40 32"
version="1.1"
id="svg5"
inkscape:version="1.1 (c68e22c387, 2021-05-23)"
sodipodi:docname="face.svg"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview7"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:document-units="mm"
showgrid="false"
width="4mm"
showguides="true"
inkscape:guide-bbox="true"
inkscape:zoom="4.6884835"
inkscape:cx="43.724159"
inkscape:cy="50.336105"
inkscape:window-width="1920"
inkscape:window-height="1054"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1"
inkscape:current-layer="layer1"
inkscape:snap-global="true">
<sodipodi:guide
position="19.999999,31.999999"
orientation="-1,0"
id="guide9"
inkscape:label=""
inkscape:locked="false"
inkscape:color="rgb(0,0,255)" />
<sodipodi:guide
position="0,2.9999999"
orientation="0,1"
id="guide11"
inkscape:label=""
inkscape:locked="false"
inkscape:color="rgb(0,0,255)" />
<sodipodi:guide
position="28.336657,20.053439"
orientation="0,-1"
id="guide1042" />
<sodipodi:guide
position="0,31.999999"
orientation="0,151.1811"
id="guide8477" />
<sodipodi:guide
position="39.999999,31.999999"
orientation="120.94488,0"
id="guide8479" />
<sodipodi:guide
position="39.999999,0"
orientation="0,-151.1811"
id="guide8481" />
<sodipodi:guide
position="0,0"
orientation="-120.94488,0"
id="guide8483" />
</sodipodi:namedview>
<defs
id="defs2" />
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1">
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="path35"
sodipodi:type="arc"
sodipodi:cx="20.000002"
sodipodi:cy="29.000002"
sodipodi:rx="22.397001"
sodipodi:ry="22.397001"
sodipodi:start="4.0101511"
sodipodi:end="5.4155569"
sodipodi:open="true"
sodipodi:arc-type="arc"
d="m 5.5331584,11.902163 a 22.397001,22.397001 0 0 1 28.9495826,0.01346" />
<rect
style="fill:#000000;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="rect3123"
width="1.3620886"
height="0.27241772"
x="-2.1316838"
y="11.505157"
transform="rotate(-37)" />
<path
id="rect3249"
style="fill:#000000;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
d="m 34.722067,9.7419343 -0.327791,0.4349927 -0.435404,-0.3281014 -0.163896,0.2174964 0.435405,0.328101 -0.328101,0.435405 0.217496,0.163896 0.328102,-0.435405 0.434992,0.32779 0.163896,-0.217496 -0.434993,-0.327791 0.32779,-0.4349924 z" />
<path
style="fill:#000000;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
d="m 19.075418,6.4278353 c -0.01451,-0.214218 -0.10023,-2.2205407 -0.0951,-2.2255612 0.01288,-0.01259 0.666146,-0.035518 1.01135,-0.035499 0.341166,1.92e-5 1.016579,0.02285 1.028786,0.034775 0.0052,0.00509 -0.09888,2.3530119 -0.104416,2.35529 -0.0022,9.087e-4 -0.19718,-0.0024 -0.433284,-0.00732 -0.407494,-0.00851 -1.128692,-0.00443 -1.312912,0.00743 l -0.08532,0.00549 z"
id="path3531" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="path4396"
sodipodi:type="arc"
sodipodi:cx="20.000002"
sodipodi:cy="29.000002"
sodipodi:rx="24.793976"
sodipodi:ry="24.793976"
sodipodi:start="4.0101511"
sodipodi:end="5.4155569"
sodipodi:open="true"
sodipodi:arc-type="arc"
d="m 3.9848862,10.072316 a 24.793976,24.793976 0 0 1 32.0478278,0.0149" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="path4500"
sodipodi:type="arc"
sodipodi:cx="20.000002"
sodipodi:cy="29.000002"
sodipodi:rx="24.793976"
sodipodi:ry="24.793976"
sodipodi:start="4.0101511"
sodipodi:end="5.4155569"
sodipodi:open="true"
sodipodi:arc-type="arc"
d="m 3.9848862,10.072316 a 24.793976,24.793976 0 0 1 32.0478278,0.0149" />
<rect
style="fill:#ffffff;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="rect6530"
width="0.99619198"
height="0.23809774"
x="19.501904"
y="5.0292072" />
<rect
style="fill:#ffffff;stroke:none;stroke-width:0.2;stroke-linecap:round;stroke-miterlimit:4;stroke-dasharray:none"
id="rect6612"
width="0.99619198"
height="0.23809774"
x="19.501904"
y="5.5685601" />
<path
id="path6805"
style="fill:none;stroke:#000000;stroke-width:0.75590552;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 70.351232 25.14266 L 69.799861 16.253941 "
transform="scale(0.26458333)" />
<path
id="path6887"
style="fill:none;stroke:#000000;stroke-width:0.75590552;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 66.60051 25.453369 L 65.643829 16.498172 "
transform="scale(0.26458333)" />
<path
id="path6946"
style="fill:none;stroke:#000000;stroke-width:0.75590552;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 60.721603 26.288978 L 59.161092 17.544741 "
transform="scale(0.26458333)" />
<path
id="path7024"
style="fill:none;stroke:#000000;stroke-width:0.75590552;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 51.194923 28.560264 L 48.68332 20.216329 "
transform="scale(0.26458333)" />
<path
id="path7102"
style="fill:none;stroke:#000000;stroke-width:0.75590552;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 39.932224 32.847187 L 36.165998 24.739902 "
transform="scale(0.26458333)" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 5.5331584,11.902163 3.9848862,10.072316"
id="path7412"
sodipodi:nodetypes="cc" />
<path
id="path8133"
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 21.403837,6.6672313 21.54972,4.3154244" />
<path
id="path8135"
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 22.396215,6.7494397 22.649337,4.3800439" />
<path
id="path8137"
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 23.951676,6.9705279 24.364561,4.6569486" />
<path
id="path8139"
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 26.472277,7.5714724 27.136805,5.3638062" />
<path
id="path8141"
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 29.452199,8.7057207 30.44868,6.5606683" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="m 34.484441,11.917066 1.548273,-1.829847"
id="path8143"
sodipodi:nodetypes="cc" />
<path
style="fill:none;stroke:#000000;stroke-width:0.2;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none"
d="M 0,1.0990401e-7 V 31.999999 H 39.999999 V 1.0990401e-7 Z"
id="path8485" />
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 8.8 KiB

21
src/modules/needy_finetuner/doc/index.md
View File

@ -1,20 +1,7 @@
# Finetuner
Schrijf de handleiding voor je module hier. Kijk gerust naar de handleiding
voor de "Doolhof"-module (`src/modules/puzzle_maze/doc/index.md`)
![](./needy_finetuner/face.svg)
Hieronder wat voorbeelden van markup die je kan gebruiken. Daarnaast kan je ook LaTeX
gebruiken (zie bijvoorbeeld de "Doolhof"-module)
Use drawings! Create the docs/images/your_module directory, put your image there and include them like this:
![](./your_module/filename.png)
Use tables! Write them like this:
| Symbol | Action to take |
|--------------------------------|----------------|
| ![](./your_module/symbol1.png) | Do nothing |
| ![](./your_module/symbol2.png) | Press the red button |
| ![](./your_module/symbol3.png) | Press the yellow button |
Deze module raakt van tijd tot tijd ontstemd. De schermverlichting knippert dan steeds intenser.
Breng de waarde met de schuifknop terug in het midden, voor de tijd op is.
Het scherm stopt met knipperen wanneer de waarde acceptabel is (of wanneer je te laat was).