modules
/
knobs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the license and readme

This commit is contained in:
mmcwilliams 2025-03-25 16:54:10 -04:00
parent 6cb3558ad5
commit e0bfb8b57f
2 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
LICENSE Normal file
View File

@ -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.

4
README.md
View File

@ -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.