From 92a74b16acb0087e5f9acaf27b2f6ef87ccbbdc9 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Sun, 7 Jul 2024 11:11:28 -0500 Subject: [PATCH] reorganize the READMEs a bit and put both in the .zip Signed-off-by: Brian S. Stephan --- Makefile | 3 +- README.md | 14 +++++---- docs/README-objects.md | 65 +++++++++--------------------------------- 3 files changed, 24 insertions(+), 58 deletions(-) diff --git a/Makefile b/Makefile index 62697a1..0475d6f 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,8 @@ all: python build.py mkdir -p ./build/docs - cp ./docs/README-objects.md ./build/README.md + cp ./docs/README.md ./build/README.md + cp ./docs/README-objects.md ./build/README-objects.md cp ./docs/assembly-and-tips.md ./build/docs/assembly-and-tips.md cp ./docs/printing-and-materials.md ./build/docs/printing-and-materials.md cp ./LICENSE ./build/LICENSE diff --git a/README.md b/README.md index cb64a01..3019a27 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,9 @@ about what the types of parts are and how to use them: * Various experiments and things not directly related to making an arcade stick. At time of writing, there's a couple pieces for a little stand for the stick, solely for vanity purposes. +Feel free to request or contribute to more objects. Additional documentation regarding assembling the stick is available +in `docs/assembly-and-tips.md`. + ## Printing These items all fit on a 256mm^2 print bed; I use a Bambu Lab P1P based on what I've learned from the @@ -161,12 +164,13 @@ to hang out and discuss issues and features and whatnot. Written by and copyright Brian S. Stephan (). -The Buildable Stick System is free software: you can redistribute it and/or modify it under the terms of the GNU General Public -License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later -version. +The Buildable Stick System is free software: you can redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any +later version. -The Buildable Stick System is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +The Buildable Stick System is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the +implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +details. You should have received a copy of the GNU General Public License along with the Buildable Stick System. If not, see . diff --git a/docs/README-objects.md b/docs/README-objects.md index 5c3f21d..e99e8ad 100644 --- a/docs/README-objects.md +++ b/docs/README-objects.md @@ -1,54 +1,11 @@ # The Buildable Stick System -Files for 3D printing an arcade stick. +Files for 3D printing an arcade stick. See `README.md` for the core documentation, this file is specific to distributed +objects. -## Objects +## Attribution -The following notes document the objects in the Buildable Stick System and how you can use them: - -* `frames/` - * `complete/` --- these are the four walls of the frame as one piece, in a couple variations for combining into - larger arcade sticks. They are simple to assemble, but you have fewer modularity/customization options, and they - are harder to print because the physics of the material cooling will probably pull the corners up. They also need - supports, since the top and bottom of the frame both have trays for panels to go into. Use at your own risk. - * `pieces/` - * `box/` --- these are the same four walls (generally speaking) as in the complete frames above, broken out into - modular pieces to print separately. Because they are separate pieces, you can mix and match colors, and you - can lay them all face down on the print surface for better adhesion and surface patterns. There are also - variants here, the "windowed" pieces, for doing two-tone variants and that kind of thing. - * `extended/` --- the frame walls are pulled out to create MCZ TE-style extended sides. Rather than getting a - box look, you get a longer slab with nice bevels. These look nice, but slightly fiddily to print (and of - course need more material) --- watch your surface adhesion. - * `interconnect` --- complete frames are bolted to one another, but for frame pieces, there is an interconnect - that stands in for the joined inner wall. You need this if you are combining multiple sets of walls, e.g. for - a two-panel-long stick. -* `panels/` - * `inset/` --- various panels, all of the same size, that fit into and flush with the frame, making the arcade stick - top or bottom. These work equally well with box or extended frames, and aside from using up a bit of the space - inside the frame, come with no downsides --- they print easily and are a pretty simple shape to tweak and remix. - * `overhang/` --- overhang panels have their plane extending over the edge of the frame, creating a bit of a - sandwich look. This is mostly an aesthetic choice, but they sit higher in the frame as well, the main panel being - over/under the frame rather than within it. This extra space is useful for taller levers. The only downside to - these is that they aren't as reusable as the inset panels, since the inset panels can go anywhere, but the - overhang panels must be designed to not overlap with other overhang panels, so you might have to make more custom - variants depending on where you put things. -* `misc/` - * Pieces that I haven't organized better (yet) --- there are decorative plates for top buttons and similar to give - more color variance and some layers to the arcade stick, some very simple dustwashers, plates that fit rocker - switches and the like in Neutrik D or 20mm holes, and a lever mount spacer for getting your lever shaft at the - desired height. You don't *need* any of these, but you'll probably use a few. -* `extras/` - * Various experiments and things not directly related to making an arcade stick. At time of writing, there's a - couple pieces for a little stand for the stick, solely for vanity purposes. - -Feel free to request or contribute to more objects, see the links to Git repos below. - -## Printing and Assembling - -Additional documentation regarding printing the objects and assembling the stick are available in -`docs/printing-and-materials.md` and `docs/assembly-and-tips.md`, respectively. - -## Author and Licensing +### Author and Licensing Written by and copyright Brian S. Stephan (). @@ -71,9 +28,13 @@ details. You should have received a copy of the GNU General Public License along with the Buildable Stick System. If not, see . -## Lineage +### Distributing BSS Sticks -Inspired by the incredible work of [TheTrain](https://github.com/TheTrainGoes) on the [OpenStickCommunity Fightstick -Case](https://github.com/OpenStickCommunity/Hardware/tree/main/Fightstick%20Case), itself based on the incredible work -by [Dash n'Mash](https://twitter.com/Dash_xx_Mash?s=20). Original work Copyright 2023 TheTrain, [licensed under CC BY -4.0](https://creativecommons.org/licenses/by/4.0/). +Under the terms of the GPLv3, you must inform the receiver of the "object code" of their rights under the GPLv3. This is +a bit of a gray area for physical objects, but likely applies to distribution of modified or unmodified STL, STEP, etc. +files at a minimum. The easiest way to satisfy the GPLv3 in either situation is to provide a link to the source code +(either the unmodified mainline project, or your copy, with modifications listed in a "prominent notice"); something +like the below should suffice in either electronic or printed form: + +> This arcade stick is part of the Buildable Stick System, version X.Y.Z; the source code to this program is available +> under the terms of the GNU General Public License, at [LINK].