Add README and license

2022-04-27 11:33:44 -07:00
parent 08847469d3
commit 99f51f334e
2 changed files with 16 additions and 0 deletions
@@ -0,0 +1,7 @@
+Copyright 2022 quinnvoker
+
+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.
@@ -0,0 +1,9 @@
+# JUQS Collars for Sanjuks V6
+
+A personal project to develop additional collar types and "gate" shapes for Sanjuks V6 levers. I devoted most of my time towards fine-tuning the "OCTN" model (nobi pro-like shape), but there are several other shapes available.
+
+I'm pretty happy with the results, but don't wish to pursue production myself, so I've made this repo open source. 
+
+Some pre-rendered OCTN collars are included in the `renders` folder.
+
+I have no plans to develop this further and will not provide support. I've done a little bit of explaining in comments, but for the most part you'll just have to hop into OpenScad and mess around with `juqs_collar.scad` if you want to render your own models. Good luck! This was my first-ever OpenScad project so be prepared to find a mess if you go digging.