dumped stuff from old repo

README.md

@@ -1,3 +1,74 @@
-# case
+# mkbd65 case
+
+CAD files for the case of mkbd65
+
+## Generate CAD files
+
+OpenSCAD Files can be created with the following command:
+
+```
+./generate_scad.py
+```
+
+You need solidpython installed for it to work. Do that by executing:
+
+```
+# creates a virtualenv
+python -m venv venv
+# activates it
+source venv/bin/activate
+# installs dependencies
+pip install -r requirements.txt
+```
+
+## Layout files
+
+These files define the layoout that gets printed on the keymat. Currently the only file included is `layout_en_us.py`
+for an english US international layout. you can use that as a template for your layout.
+
+The file should define a single variable `LAYOUT` which is a list of roaws. These rows are also lists of columns. Each
+column has keys, which are a list of the strings that should be printed at different positions.
+
+Example for a one button keyboard with the labels `foo` in the top left corner and `bar` in the bottom left:
+
+```
+LAYOUT = [
+    [
+        ['foo', 'bar', '', '', ''],
+    ],
+]
+```
+
+The label string will be used as `[TopLeft, BottomLeft, TopRight, BottomRight, Middle]`.
+
+Some strings need special escaping to be used in OpenScad later on. See the en_us layout for examples.
+
+## Phone config
+
+Properties for different phones are saved in INI files. Currently the only file included is `oneplus5t.ini` for the
+Oneplus 5t phone with a english US international layout with the DejaVu Sans font.
+
+In the config file you can define phone specific aspects and style such as the used font and layout. Here is a list of
+the possile options:
+
+| Group  | Option    | Type   | Default                | Description                   |
+| ------ | --------- | ------ | ---------------------- | ----------------------------- |
+| keymap | thickness | Number | 0.5                    | Thickness of the keymap in mm |
+|        | layout    | String | en_us-intl             | Layout file used for labels   |
+| key    | thickness | Number | 1                      | Thickness of the key in mm    |
+|        | font      | String | DejaVu Sans:style=Bold | Font used for labels          |
+
+
+OpenScad files
+--------------
+
+The generator script `generate_scad.py` creates multiple files.
+
+| File                  | Material | Description                                         |
+| --------------------- | -------- | --------------------------------------------------- |
+| mkbd65_keymat.scad    | TPU      | Keymat should be printed with a 3D printer          |
+| mkbd65_pcb.scad       | -        | Just a spacer for the 3D model fitting              |
+| mkbd65_top_plate.scad | Aluminum | Laser cut on a CNC                                  |
+| mkbd65_internals.scad | ABS/PLA  | Inner structure should be printed with a 3D printer |
+| mkbd65.scad           | -        | Combination of the above files                      |
 
-CAD files for the case of mkbd65