diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0d2af71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2025 M McWilliams + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 482c496..eb3a64c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Knobs -This repo contains a parametric knob generator for quickly generating tactile knobs for standard metric bolts. +This repo contains a parametric knob generator for quickly generating tactile knobs for standard metric bolts and nuts. ## Example @@ -11,5 +11,5 @@ knob(H = 10, D = 14, DEPTH = 4, BOLT = "M4", TYPE = "hex"); ``` -This will generate a knob that is 10mm high, has a diameter of 14m and takes an M4 hex bolt that sits 4mm from the bottom. +This will generate a knob that is 10mm high, has a diameter of 14m and takes M4 hex hardware that sits 4mm from the bottom. An M4 bolt can be dropped in, or an M4 nut. \ No newline at end of file