From 7d010f700fec56b93cc8c07169c945841699ff6d Mon Sep 17 00:00:00 2001 From: Sam Hadow Date: Sat, 28 Mar 2026 10:13:40 +0100 Subject: [PATCH] readme update --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index e69de29..aba5c0c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,15 @@ +# keyboard_scad + +This repository contains various openscad scripts for keyboard related parts. It also contains bash scripts to run the openscad scripts and generate stl files. + +## Bash scripts: + +| Script | Action | +| :- | :- | +| **keyboard60_ortholinear.sh** | generate the backplate and the case for a 60% ortholinear keyboard +| **keycaps_ortholinear.sh** | generate the keycaps for a 60% ortholinear keyboard +| **keyboard60.sh** | generate the backplate and the case for a 60% ANSI layout keyboard +| **numpad.sh** | generate the backplate and the case for a 21 keys numpad +| **keycaps_numpad.sh** | generate the keycaps for a 21 keys numpad + +*the keybord generation bash scripts outputs cut in half backplates and cases so you can print them on a standard 3d printer plate.*