From 654874fb5fd1aa9467d25847b0a2f58ecbbdc5b9 Mon Sep 17 00:00:00 2001 From: Will Harris Date: Fri, 12 Jun 2020 16:07:31 -0600 Subject: [PATCH] Added clear instructions to which line you should modify to generate a key Addition to the README and a slight change in formatting to accommodate the extra information --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cd91e92..43e1356 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,16 @@ If you are technically inclined at all, this is definitely the best way to run t First, you'll need OpenSCAD: http://www.openscad.org/downloads.html. I highly recommend installing the development snapshot, as they generally support more features and are relatively stable. Development snapshots are listed in their own section on the downloads page. -After you have openSCAD installed, you need to download the code and run it. running `git clone https://github.com/rsheldiii/openSCAD-projects.git` if you have git, or downloading [this zip](https://github.com/rsheldiii/openSCAD-projects/archive/master.zip) and extracting the directory should do it. Then all you need to do is open `keys.scad` with openSCAD and you are set! It is possible to edit this project with an external editor by checking off Design => 'Automatic Reload and Preview' in OpenSCAD. +After you have openSCAD installed, you need to download the code and run it. running `git clone https://github.com/rsheldiii/openSCAD-projects.git` if you have git, or downloading [this zip](https://github.com/rsheldiii/openSCAD-projects/archive/master.zip) and extracting the directory should do it. + +To make your own key, all you need to do is open `keys.scad` with openSCAD and [modify this line](https://github.com/rsheldiii/KeyV2/blob/master/keys.scad#L12)! (Line 12) + +Here is an example you can replace the line with to get started. This is for a ctrl key on an OEM keyboard: +`u(1.25) oem_row(3) legend("ctrl", size=4.5) key();` + + + +It is possible to edit this project with an external editor by checking off Design => 'Automatic Reload and Preview' in OpenSCAD. All examples below assume you are running the library on your computer with OpenSCAD.