feat: add tables to README.md

Thanks to [arialdomartini](https://github.com/arialdomartini) for the Markdown Tables idea.
This commit is contained in:
Nikita Shirokov 2024-11-07 05:54:44 +07:00 committed by GitHub
parent 90dc17136a
commit 8d318d51b6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -4,22 +4,25 @@
The repository contains these folders:
- **Fusion 360** source files for [Autodesk Fusion 360](https://www.autodesk.com/products/fusion-360/overview).
- **STL** 3D models for any CAD of Slicer software.
- **Lychee** project files for [Lychee Slicer](https://mango3d.io/). You might need to update model paths to edit files.
- **CTB (Mars 2 Pro)** print-ready files for [Elegoo Mars 2 Pro](https://www.elegoo.com/collections/mars-series/products/elegoo-mars-2-pro-mono-lcd-3d-printer) and Elegoo water-washable resin.
- **Assets** images and actual photos of keycaps.
- **Blender** Blender files for Preview and managing Combined versions.
| Folder | Description |
|:---------------------|:-----------------------------------------------------------------------------------------------------------|
| **Fusion 360** | Source files for [Autodesk Fusion 360](https://www.autodesk.com/products/fusion-360/overview) |
| **STL** | 3D models for any CAD of Slicer software |
| **Lychee** | Project files for [Lychee Slicer](https://mango3d.io/). You might need to update model paths to edit files |
| **CTB (Mars 2 Pro)** | Print-ready files for [Elegoo Mars 2 Pro](https://www.elegoo.com/collections/mars-series/products/elegoo-mars-2-pro-mono-lcd-3d-printer) and Elegoo water-washable resin. |
| **Assets** | Images and actual photos of keycaps |
| **Blender** | Blender files for Preview and managing Combined versions |
There are currently seven variants of keycaps:
- **Normal**. Just a flat keycap profile with a small recess, that is soothing for fingers.
- **Normal Tilted**. Same as Normal, but top profile has a 15° tilt and 0.5mm upward height compensation.
- **Normal Homing**. Has three little bumps that is useful to determine home positions.
- **Thumb**. Same as Normal, but top profile has a cut along down side.
- **Saddle**. Same as Thumb, but top profile has two symmetrical cuts.
- **Saddle Tilted**. Tilted version of Saddle. Same 15° and height compensation.
- **Saddle Homing**. Has three little bumps that is useful to determine home positions.
| Variant | Description |
|:------------------|:------------------------------------------------------------------------------------|
| **Normal** | Just a flat keycap profile with a small recess, that is soothing for fingers |
| **Normal Tilted** | Same as Normal, but top profile has a 15° tilt and 0.5mm upward height compensation |
| **Normal Homing** | Has three little bumps that is useful to determine home positions |
| **Thumb** | Same as Normal, but top profile has a cut along down side |
| **Saddle** | Same as Thumb, but top profile has two symmetrical cuts |
| **Saddle Tilted** | Tilted version of Saddle. Same 15° and height compensation |
| **Saddle Homing** | Has three little bumps that is useful to determine home positions |
## What keycaps do I need for my keyboard?
@ -27,14 +30,18 @@ First, you should pick Choc or MX stem variant. Then, for keycap set there are s
For corne-like keyboards with 36-keys I use:
- 20 Saddle Tilted (for top and bottom rows)
- 16 Saddle (10 for home row + 6 for thumbs)
| Amount | Kind | Purpose |
|-------:|:--------------|:----------------------------|
| 20 | Saddle Tilted | For top and bottom rows |
| 16 | Saddle | For home row + 6 for thumbs |
or
- 20 Normal Tilted (for top and bottom rows)
- 10 Normal (for home row)
- 6 Thumb
| Amount | Kind | Purpose |
|-------:|:--------------|:----------------------------|
| 20 | Normal Tilted | For top and bottom rows |
| 10 | Normal | For home row |
| 6 | Thumb | For thumbs |
## How to print?