updated mkdocs documentation
This commit is contained in:
ploopyco
parent
9106bb111e
commit
bf09304d7d
|
|
@ -0,0 +1,23 @@
|
|||
# Appendix B: 3D printed parts
|
||||
|
||||
# Buying 3D-printed parts from us
|
||||
Not everyone has access to a 3D-printer. [That's why we sell kits with everything you need to build a Ploopy Adept Trackball](https://ploopy.co/product-category/trackball/adept/). Here's why that's great for you:
|
||||
|
||||
- You get all of the 3D-printed parts, guaranteed free of manufacturing defects
|
||||
- You won't waste time spending hours tweaking settings
|
||||
- We guarantee it will fit together *perfectly*
|
||||
|
||||
Consider it. You're a smartie. You'll get there.
|
||||
|
||||
# Printing your own parts
|
||||
|
||||
So, you have a printer and want to print your own parts? Great! We don't have specific instructions, since every printer setup is different. All of the STLs are available, and if you need to make tweaks, you can alter the design files.
|
||||
|
||||
Here are the settings we use when we print parts. **Note that these settings have only been tested on the Prusa i3 MK2.5S and MK3S.** If you have another printer, you may need to tweak these settings.
|
||||
|
||||
- PLA. The geometry of many of the parts is quite complex; trying to use other materials may not result in success.
|
||||
- 0.30mm layer height. You can go finer than this if you want, but we haven't tested that. Going coarser is not going to work; first, it's going to feel rough on your hand, and second, it won't accurately capture the necessary detail.
|
||||
- No support material is required anywhere. However, your printer must have the capability of bridging distances of up to 40mm.
|
||||
- Orient the pieces so that flat sides are on the build plate.
|
||||
- We like gyroid for infill pattern, but anything is probably good. Cubic, rectilinear, whatever.
|
||||
- We use 0.4mm nozzles. We haven't tested other nozzle sizes.
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
# Appendix C: Hardware
|
||||
|
||||
# Buying hardware from us
|
||||
|
||||
Getting all of the hardware on your own can be tricky because the parts you select may not fit perfectly. [That's why we sell kits with everything you need to build a Ploopy Adept Trackball](https://ploopy.co/product-category/trackball/adept/). Here's why that's great for you:
|
||||
|
||||
- Everything is guaranteed to fit together perfectly
|
||||
- Everything is guaranteed to work as intended
|
||||
- You'll end up saving money - probably quite a bit of money - by not spending on extra parts
|
||||
|
||||
Your call. You'll sort it out.
|
||||
|
||||
# Getting your own hardware
|
||||
|
||||
This guide was a bit light on detail in the other sections, and that's because the hardware has to conform to many specifications. They'll all be listed here.
|
||||
|
||||
First, a complete list of all the hardware you'll need:
|
||||
|
||||
- 4x Small Screws
|
||||
- 3x MR63ZZ Roller Bearings
|
||||
- 4x Friction Pads
|
||||
- 1x Snooker Ball
|
||||
|
||||
We'll be going over all of them in detail. There will be mentions of *critical specifications*; if you're going to be sourcing your own parts, **you must get parts that conform to the critical specifications**. If you go off-menu, the parts will not fit the way that we intended when we designed the trackball. That might mean that your trackball **doesn't work**.
|
||||
|
||||
Let's get cracking.
|
||||
|
||||
## Small Screws
|
||||
|
||||
Here are the critical specifications:
|
||||
|
||||
- \#2
|
||||
- 3/8" length
|
||||
|
||||
## MR63ZZ Roller Bearings
|
||||
Here are the critical specifications:
|
||||
|
||||
- MR63ZZ bearing
|
||||
- 3mm inner diameter
|
||||
- 6mm outer diameter
|
||||
- 2.5mm thickness
|
||||
|
||||
## Friction pads
|
||||
Here are the critical specifications:
|
||||
|
||||
- Circular shape
|
||||
- Up to 3/4" diameter
|
||||
- Up to 1/8" thickness
|
||||
- Non-slip
|
||||
|
||||
## Snooker ball
|
||||
We use 1.75-inch diameter (44.45mm) miniature snooker balls. Any ball between 44.0mm and 44.6mm will work.
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
# Appendix A: Printed circuit boards
|
||||
|
||||
|
||||
## Buying boards from us
|
||||
Getting the Ploopy boards made can be complex, and expensive, especially if you only need one set. [That's why we sell kits with everything you need to build a Ploopy Adept Trackball](https://ploopy.co/product-category/trackball/adept/). Here's why that's great for you:
|
||||
|
||||
- You get a PCB with all components soldered
|
||||
- The firmware is already programmed on the microcontroller, so you won't have to program it
|
||||
- It'll cost a hell of a lot less than if you do a production run of PCBs just for yourself
|
||||
- You won't have to order components and wait while they come in
|
||||
- We guarantee that it works
|
||||
|
||||
Just something to consider. You're smart. You'll figure it out.
|
||||
|
||||
## Making your own boards
|
||||
|
||||
Want to make your own Ploopy Adept Trackball boards? Great! Less work for us. Seriously, though, only choose this option if you know what you're doing. You don't want to embarrass yourself, do you?
|
||||
|
||||
### Step 1: Order the PCBs from a PCB production company
|
||||
|
||||
Here are the most important configurations you'll need to communicate to the company:
|
||||
|
||||
- 4 layers
|
||||
- FR-4, TG 150-160 (basically, whatever the cheapest option is)
|
||||
- 0.8mm thickness
|
||||
- 6/6mil track/spacing distance
|
||||
- 0.3mm minimum hole size
|
||||
- ENIG surface finish, but you can go with HASL if you don't care about lead poisoning
|
||||
- 1oz copper thickness for both outer and inner layers
|
||||
- Choose whatever colours you want for solder mask and silkscreen; we like white solder mask and black silkscreen
|
||||
|
||||
If something is missing from here, it's not really important.
|
||||
|
||||
At some point, you'll have to upload design files to the production company. Use the [electronics source files](https://github.com/ploopyco/adept-trackball/tree/master/hardware/electronics) to generate manufacturing files (you'll have to convert them from their native Altium format if you're using some other platform). That should contain everything you need to get the boards made. If the production company rejects this package, however, you'll need to address the issue yourself.
|
||||
|
||||
### Step 2: Order the electronics components
|
||||
|
||||
All of the components are described in the schematics of the PCBs. Ordering the components is left as an exercise for the reader.
|
||||
|
||||
A complete list of all of the components can be found in the electrical design files.
|
||||
|
||||
### Step 3: Get the necessary tools
|
||||
|
||||
- PCB
|
||||
- All of the electronics components
|
||||
- A soldering iron
|
||||
- Solder
|
||||
- A printout of the schematics
|
||||
|
||||
### Step 4: Solder the components to the boards
|
||||
|
||||
Once you've got the PCBs and all of the components, print out the schematics. Use the schematics to match the reference designators on the PCBs to the reference designators on the schematics, and then get to soldering.
|
||||
|
||||
If you've never soldered surface mount components before, or want a refresher on how to solder, we recommend [this video on using an iron to solder surface mount components](https://www.youtube.com/watch?v=3NN7UGWYmBY), and [this video on using a hot-air soldering station](https://www.youtube.com/watch?v=c_Qt5CtUlqY).
|
||||
|
||||
Lastly, you'll need to follow a set of special instructions to assemble the PMW3360 sensor and the optic. [Take a look at page 11 of the official PMW3360 datasheet to find out how to do this](https://d3s5r33r268y59.cloudfront.net/datasheets/9604/2017-05-07-18-19-11/PMS0058-PMW3360DM-T2QU-DS-R1.50-26092016._20161202173741.pdf) (page 8 has visuals, for those of you who like purdy pictures).
|
||||
|
||||
**MAKE SURE THAT THE PMW3360 IS ORIENTED CORRECTLY BEFORE YOU SOLDER IT!** This is a really easy step to mess up, so *DOUBLE-CHECK IT!*
|
||||
|
||||
### Step 5: All done!
|
||||
|
||||
Congrats, you finished assembling the electronics! Pat yourself on the back.
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
# Appendix D: QMK Firmware Programming
|
||||
|
||||
|
||||
# Working with QMK
|
||||
|
||||
Ploopy devices are fairly easy to program and reprogram, thanks to the excellent work by all of the developers and maintainers of the [QMK firmware suite](https://github.com/qmk/qmk_firmware).
|
||||
|
||||
## Madromys? What's that?
|
||||
|
||||
`madromys` is our internal codename for the Ploopy Adept. We don't always know what we're going to call the devices as we're designing them, so we assign codenames to them. This naming convention is also present in some public places, such as the QMK repository. If you see `madromys` while you're working with QMK, just know that the Adept and `madromys` are the same thing.
|
||||
|
||||
## Before you begin
|
||||
|
||||
If you have never used QMK before, go through [all of the steps in the QMK guide to set up your environment](https://docs.qmk.fm/#/newbs_getting_started).
|
||||
|
||||
QMK was built for keyboards, so you'll see lots of references to code that looks like the following:
|
||||
|
||||
`-kb <keyboard>`
|
||||
|
||||
Whenever you see that, use the following syntax:
|
||||
|
||||
`-kb ploopyco/madromys/rev1_001`
|
||||
|
||||
and you'll be fine.
|
||||
|
||||
## Building the Ploopy device firmware
|
||||
|
||||
With your terminal window open and pointed at your QMK build environment, compile the firmware with the following command:
|
||||
|
||||
`qmk compile -kb ploopyco/madromys/rev1_001 -km via`
|
||||
|
||||
Alternatively, you can invoke the Makefile directly with the following:
|
||||
|
||||
`make ploopyco/madromys/rev1_001:via`
|
||||
|
||||
If you wish, you can use the default keymap (with `qmk compile -kb ploopyco/madromys/rev1_001 -km default` or `make ploopyco/madromys/rev1_001:default`). However, the VIA keymap is particularly interesting because it allows for customization of the trackball's functions without reflashing the firmware, through the use of the convenient [VIA software package](https://github.com/the-via/releases/releases). It's incredibly handy, so definitely check it out.
|
||||
|
||||
For more details on building QMK firmware in general, see the [QMK firmware guide](https://docs.qmk.fm/#/newbs_building_firmware).
|
||||
|
||||
## Putting the Ploopy device into bootloader mode
|
||||
|
||||
Putting the Ploopy device into bootloader mode is very easy.
|
||||
|
||||
1. Unplug it from your computer.
|
||||
2. Hold down the Bottom Left button on the Adept.
|
||||
3. Plug the Ploopy device into your computer.
|
||||
4. The computer should recognise that a mass storage device was just plugged in. Once this is done, you should be able to drag and drop files onto the Ploopy device, as if the board was a USB drive. Feel free to remove the tweezers or paperclip at this point.
|
||||
|
||||
And that's it. While plugged in this way, the Ploopy device will accept new firmware.
|
||||
|
||||
If you want to upload a new firmware file (a ".uf2" file, like "ploopy_adept_v42069" or something), just drag it into the folder, and it'll automatically install on the Ploopy device and restart itself.
|
||||
|
||||
Whenever you want to put new firmware onto the Ploopy device, go through these steps again.
|
||||
|
||||
**TIP**: If your firmware is in some kind of strange state and uploading new firmware isn't fixing it, try uploading [a flash nuke](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython/circuitpython#flash-resetting-uf2-3083182) to the Adept before flashing the new firmware. It wipes the memory of the Adept completely clean, which can help clear a few types of errors.
|
||||
|
||||
## Putting the Ploopy device into bootloader mode if it's bricked
|
||||
|
||||
Putting the Ploopy device into bootloader mode if it's bricked is a bit more involved, but still doable.
|
||||
|
||||
1. Unplug it from your computer.
|
||||
2. Open it by removing the screws in the base and removing the top.
|
||||
3. Look for a pair of vias (gold-plated holes) on the board. You can see where they're located [in this photo](https://ploopy.co/wp-content/uploads/2023/11/boot.jpg).
|
||||
4. Get a paper clip (non-insulated, i.e. no plastic shit covering it) or a pair of tweezers, or some wire. Whatever you've got on hand that's metal.
|
||||
5. Stick the paper clip or tweezers into the holes. You're trying to form an electrical connection between the two holes.
|
||||
6. While you've got the two vias connected with your metal bridge, plug the Ploopy device into your computer.
|
||||
7. The computer should recognise that a mass storage device was just plugged in. Once this is done, you should be able to drag and drop files onto the Ploopy device, as if the board was a USB drive. Feel free to remove the tweezers or paperclip at this point.
|
||||
|
||||
And that's it. While plugged in this way, the Ploopy device will accept new firmware.
|
||||
|
||||
## And that's it!
|
||||
|
||||
Happy customizing!
|
||||
|
|
@ -0,0 +1,208 @@
|
|||
# Ploopy Kit Assembly Instructions
|
||||
|
||||
## BEFORE YOU DO ANYTHING, READ THIS FIRST.
|
||||
|
||||
**Do not flash new firmware until you've verified that the electronics are all working.**
|
||||
|
||||
That means, finish building the trackball, plug it in, use the stock firmware for about five minutes. Verify that the cursor is moving, and all the buttons are working.
|
||||
|
||||
Once you've verified that it all works, you're good to go flashing new firmware.
|
||||
|
||||
## Main Instructions
|
||||
|
||||
|
||||
|
||||
In this section, you'll go over how to build an Adept Trackball from the official Ploopy Adept Trackball kit.
|
||||
|
||||
Note that some of these pictures were taken at different times, so they may show a bit of inconsistency in between steps.
|
||||
|
||||
### Step 1: Get the necessary tools
|
||||
|
||||
|
||||
|
||||
- A #1 Phillips head screwdriver (or similar; you're looking for a small-ish screwdriver here)
|
||||
- Soldering iron
|
||||
- Solder
|
||||
|
||||
A pair of tweezers and needle-nose pliers may also be helpful during this process.
|
||||
|
||||
### Step 2: Break any leftover tabs off the PCB
|
||||
|
||||
|
||||
|
||||
- In the photo, a "tab" is being pulled by the pliers.
|
||||
- There may be up to six small tabs on the outside of the PCB.
|
||||
- Use a set of pliers to gently break the tabs off.
|
||||
|
||||
|
||||
### Step 3: Prepare the PCB for soldering
|
||||
|
||||
|
||||
|
||||
Prepare the following components:
|
||||
|
||||
- Printed circuit board
|
||||
- PMW-3360 chip
|
||||
- PMW-3360 optic
|
||||
|
||||
The PMW-3360 chip will come in a small piece of foam. Go ahead and remove it now.
|
||||
|
||||
|
||||
### ***STOP! Read the next step fully before continuing.***
|
||||
|
||||
### Step 4: Solder PMW-3360 sensor to printed circuit board
|
||||
|
||||
|
||||
|
||||
Before soldering:
|
||||
|
||||
- **MAKE 👏 SURE 👏 THAT 👏 THE 👏 PMW-3360 👏 IS 👏 ORIENTED 👏 CORRECTLY 👏 BEFORE 👏 YOU 👏 SOLDER 👏 IT!** This is a really easy step to mess up, so *CHECK IT TWICE!*
|
||||
- See the photo for clarification. Note the orientation of the text on the chip, as well as the pattern of dots on the chip. Also note the "1" on the printed circuit board.
|
||||
- One warning to double-check the sensor orientation isn't sufficient. Stop what you're doing, right now, and check it. **Seriously.** Be kind to your future self, and save yourself a headache.
|
||||
- Once you are absolutely sure that you have oriented the PMW-3360 correctly, solder it down.
|
||||
- The sensor must be flat down as far as it can possibly slide into the holes before soldering. Don't let it "float" while you're soldering the first pin down.
|
||||
|
||||
### Step 5: Remove the tab of kapton tape on the PMW-3360
|
||||
|
||||
|
||||
|
||||
- There are two small tabs of orange tape covering the sensors main holes. Remove them now.
|
||||
- Try to do this in a dust-free environment.
|
||||
- Check your solder joints during this step to ensure that they are good.
|
||||
|
||||
### Step 6: Attach the optic to the PMW-3360
|
||||
|
||||
|
||||
|
||||
- Orient the optic correctly before insertion. It should **NOT** require any force to insert fully; if it does, remove it and check the orientation before trying again.
|
||||
|
||||
### Step 7: Place the PCB into the Base
|
||||
|
||||
|
||||
|
||||
### Step 8: Place the Sensor Cap on the PCB
|
||||
|
||||
|
||||
|
||||
- The Sensor Cap doesn't snap onto the PMW-3360 optic. It "floats" on top of the optic for now. Once fully assembled, the Sensor Cap will be securely held down.
|
||||
- The position of the Sensor Cap doesn't precisely matter for the moment. Just try to get it roughly centered on the optic.
|
||||
|
||||
### Step 9: Place the Top onto the Base
|
||||
|
||||
|
||||
|
||||
- If necessary, adjust the position of the Sensor Cap as you're lowering the Top onto the Base.
|
||||
|
||||
### Step 10: Screw the Base into the Top
|
||||
|
||||
|
||||
|
||||
- Go slowly as you drive screws during this step. When you feel significant resistance, **stop**.
|
||||
|
||||
### Step 11: Prepare bearing press jig
|
||||
|
||||
|
||||
|
||||
Prepare the following components:
|
||||
|
||||
- Bearing press jig
|
||||
- 3x roller bearing
|
||||
- 3x roller bearing dowel
|
||||
|
||||
### Step 12: Insert roller bearing and roller bearing dowel into bearing
|
||||
|
||||
|
||||
|
||||
### Step 13: Press the bearing press jig together
|
||||
|
||||
|
||||
|
||||
This may require a surprising amount of force. Try your best not to bend the roller bearing dowel, but if you do, there should be spares with your kit parts.
|
||||
|
||||
### Step 14: Remove bearing from bearing press jig and repeat
|
||||
|
||||
|
||||
|
||||
At the end, all of your bearings should look like this.
|
||||
|
||||
### Step 15: Insert roller bearings into the Top
|
||||
|
||||
|
||||
|
||||
- Ensure that the bearings are pressed all the way into the case. If the bearings aren't seated all the way, there's a good chance that the ball will become badly scratched.
|
||||
- Needle nose pliers or some similar tool can be used to ensure that the bearing is fully seated.
|
||||
|
||||
### Step 16: Prepare the Friction Pads
|
||||
|
||||
|
||||
|
||||
Prepare the following components:
|
||||
|
||||
- Adept body
|
||||
- 4x Friction Pads
|
||||
|
||||
### Step 17: Place Friction Pads on Base
|
||||
|
||||
|
||||
|
||||
- Do your best not to cover the screw holes with the friction pads, as this will make opening the case more difficult in the future.
|
||||
|
||||
### Step 18: Insert the ball
|
||||
|
||||
|
||||
|
||||
### Step 19: Peel and stick the logo to the Top
|
||||
|
||||
|
||||
|
||||
This isn't strictly necessary, but we think it looks nice.
|
||||
|
||||
### Step 20: Verify that the Ploopy Adept Trackball is working correctly
|
||||
|
||||
Plug the trackball into your computer. If you move the ball, it should move the cursor.
|
||||
|
||||
### Step 21: Spin the ball to break in the bearings
|
||||
|
||||
The bearings are a bit scratchy when they're new. To prevent them from jumping around during initial use, spin the ball with some Latin dance vigour for about three minutes. That should be enough to break them in.
|
||||
|
||||
The bearings will take about a week to become fully broken-in.
|
||||
|
||||
### Step 22: All done!
|
||||
|
||||
Congrats, you finished building the Ploopy Adept Trackball!
|
||||
|
||||
It's done! Love it, use it, but don't you dare abuse it!
|
||||
|
||||
## FAQ
|
||||
|
||||
### Some buttons seem "sticky", or are too low, or are permanently clicking. What do I do?
|
||||
|
||||
Sometimes, the buttons on the Top need to be adjusted so that the distance between the button and the switch on the PCB are correct. You can do this either when the Top is installed or when it's removed.
|
||||
|
||||
The buttons can be adjusted quite far without breaking, but still, **do this slowly**. Don't move the buttons too far at one time.
|
||||
|
||||
[A video of how to adjust the Top when the Top is removed is available here.](https://imgur.com/2l5EsTi) This is the recommended route as it has the lowest possibility of damaging the Top.
|
||||
|
||||
[A video of how to adjust the Top when the Top is installed is available here.](https://imgur.com/OqEk2X5) This is only recommended if you have the capability of reprinting your own Top in case you break this one.
|
||||
|
||||
### I've plugged in the Adept, but none of the buttons are working, and the cursor isn't working. What's wrong?
|
||||
|
||||
You have a bad cable.
|
||||
|
||||
To expand: many USB-C cables only provide power, and their data wires aren't actually connected. If your computer seems to recognize that a device has been plugged in, but none of the buttons are working and the cursor isn't moving, the problem is almost certainly the cable.
|
||||
|
||||
Try using the Adept with a cable that you've verified to work with another device. If that still doesn't solve the problem, send an email to contact@ploopy.co.
|
||||
|
||||
### One or more of the rollers seems to be badly stuck. What do I do?
|
||||
|
||||
Take a look at this photo:
|
||||
|
||||
|
||||
|
||||
Circled in red, you should notice a small piece of plastic sticking up into the well where the roller bearing sits. This piece of plastic can interrupt the regular movement of the roller bearing, causing it to seize up.
|
||||
|
||||
Remove the bearing that's not rolling correctly from the Top and look for this piece of plastic. You should be able to remove it with a pair of tweezers, though you may have to scrape quite hard to get it off.
|
||||
|
||||
### The buttons are all working, but the cursor isn't. What's going on?
|
||||
|
||||
The sensor likely isn't soldered correctly. Double-check all of your solder connections, touch them up with some flux if you have it, and try again. If it still isn't working, send an email to contact@ploopy.co.
|
||||
|
|
@ -1,17 +1,13 @@
|
|||
# Welcome to MkDocs
|
||||
# Home
|
||||
|
||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
||||
So, you want to build a Ploopy Adept Trackball, eh? Or, maybe you want to replace some broken parts. Maybe you want to reprogram it. Or maybe you just want to know how it all works. No matter the motivation, this is the place to learn.
|
||||
|
||||
## Commands
|
||||
**Bought a kit and itching to get it built?** --> Get started by going to the [assembly instructions](assembly-instructions.md).
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs -h` - Print help message and exit.
|
||||
**Looking to purchase a kit with everything you need to build your own Ploopy Adept?** --> [Check out the Ploopy store](https://ploopy.co/product-category/trackball/adept/).
|
||||
|
||||
## Project layout
|
||||
**Building a Ploopy Adept Trackball from scratch?** --> Get started by going to [Appendix A: Printed circuit boards](appendices/pcbs.md).
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
---
|
||||
|
||||
*Copyright (C) 2023 Ploopy Corporation. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".*
|
||||
|
|
@ -0,0 +1,445 @@
|
|||
# GNU Free Documentation License
|
||||
|
||||
Version 1.3, 3 November 2008
|
||||
|
||||
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation,
|
||||
Inc. <https://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
#### 0. PREAMBLE
|
||||
|
||||
The purpose of this License is to make a manual, textbook, or other
|
||||
functional and useful document "free" in the sense of freedom: to
|
||||
assure everyone the effective freedom to copy and redistribute it,
|
||||
with or without modifying it, either commercially or noncommercially.
|
||||
Secondarily, this License preserves for the author and publisher a way
|
||||
to get credit for their work, while not being considered responsible
|
||||
for modifications made by others.
|
||||
|
||||
This License is a kind of "copyleft", which means that derivative
|
||||
works of the document must themselves be free in the same sense. It
|
||||
complements the GNU General Public License, which is a copyleft
|
||||
license designed for free software.
|
||||
|
||||
We have designed this License in order to use it for manuals for free
|
||||
software, because free software needs free documentation: a free
|
||||
program should come with manuals providing the same freedoms that the
|
||||
software does. But this License is not limited to software manuals; it
|
||||
can be used for any textual work, regardless of subject matter or
|
||||
whether it is published as a printed book. We recommend this License
|
||||
principally for works whose purpose is instruction or reference.
|
||||
|
||||
#### 1. APPLICABILITY AND DEFINITIONS
|
||||
|
||||
This License applies to any manual or other work, in any medium, that
|
||||
contains a notice placed by the copyright holder saying it can be
|
||||
distributed under the terms of this License. Such a notice grants a
|
||||
world-wide, royalty-free license, unlimited in duration, to use that
|
||||
work under the conditions stated herein. The "Document", below, refers
|
||||
to any such manual or work. Any member of the public is a licensee,
|
||||
and is addressed as "you". You accept the license if you copy, modify
|
||||
or distribute the work in a way requiring permission under copyright
|
||||
law.
|
||||
|
||||
A "Modified Version" of the Document means any work containing the
|
||||
Document or a portion of it, either copied verbatim, or with
|
||||
modifications and/or translated into another language.
|
||||
|
||||
A "Secondary Section" is a named appendix or a front-matter section of
|
||||
the Document that deals exclusively with the relationship of the
|
||||
publishers or authors of the Document to the Document's overall
|
||||
subject (or to related matters) and contains nothing that could fall
|
||||
directly within that overall subject. (Thus, if the Document is in
|
||||
part a textbook of mathematics, a Secondary Section may not explain
|
||||
any mathematics.) The relationship could be a matter of historical
|
||||
connection with the subject or with related matters, or of legal,
|
||||
commercial, philosophical, ethical or political position regarding
|
||||
them.
|
||||
|
||||
The "Invariant Sections" are certain Secondary Sections whose titles
|
||||
are designated, as being those of Invariant Sections, in the notice
|
||||
that says that the Document is released under this License. If a
|
||||
section does not fit the above definition of Secondary then it is not
|
||||
allowed to be designated as Invariant. The Document may contain zero
|
||||
Invariant Sections. If the Document does not identify any Invariant
|
||||
Sections then there are none.
|
||||
|
||||
The "Cover Texts" are certain short passages of text that are listed,
|
||||
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
||||
the Document is released under this License. A Front-Cover Text may be
|
||||
at most 5 words, and a Back-Cover Text may be at most 25 words.
|
||||
|
||||
A "Transparent" copy of the Document means a machine-readable copy,
|
||||
represented in a format whose specification is available to the
|
||||
general public, that is suitable for revising the document
|
||||
straightforwardly with generic text editors or (for images composed of
|
||||
pixels) generic paint programs or (for drawings) some widely available
|
||||
drawing editor, and that is suitable for input to text formatters or
|
||||
for automatic translation to a variety of formats suitable for input
|
||||
to text formatters. A copy made in an otherwise Transparent file
|
||||
format whose markup, or absence of markup, has been arranged to thwart
|
||||
or discourage subsequent modification by readers is not Transparent.
|
||||
An image format is not Transparent if used for any substantial amount
|
||||
of text. A copy that is not "Transparent" is called "Opaque".
|
||||
|
||||
Examples of suitable formats for Transparent copies include plain
|
||||
ASCII without markup, Texinfo input format, LaTeX input format, SGML
|
||||
or XML using a publicly available DTD, and standard-conforming simple
|
||||
HTML, PostScript or PDF designed for human modification. Examples of
|
||||
transparent image formats include PNG, XCF and JPG. Opaque formats
|
||||
include proprietary formats that can be read and edited only by
|
||||
proprietary word processors, SGML or XML for which the DTD and/or
|
||||
processing tools are not generally available, and the
|
||||
machine-generated HTML, PostScript or PDF produced by some word
|
||||
processors for output purposes only.
|
||||
|
||||
The "Title Page" means, for a printed book, the title page itself,
|
||||
plus such following pages as are needed to hold, legibly, the material
|
||||
this License requires to appear in the title page. For works in
|
||||
formats which do not have any title page as such, "Title Page" means
|
||||
the text near the most prominent appearance of the work's title,
|
||||
preceding the beginning of the body of the text.
|
||||
|
||||
The "publisher" means any person or entity that distributes copies of
|
||||
the Document to the public.
|
||||
|
||||
A section "Entitled XYZ" means a named subunit of the Document whose
|
||||
title either is precisely XYZ or contains XYZ in parentheses following
|
||||
text that translates XYZ in another language. (Here XYZ stands for a
|
||||
specific section name mentioned below, such as "Acknowledgements",
|
||||
"Dedications", "Endorsements", or "History".) To "Preserve the Title"
|
||||
of such a section when you modify the Document means that it remains a
|
||||
section "Entitled XYZ" according to this definition.
|
||||
|
||||
The Document may include Warranty Disclaimers next to the notice which
|
||||
states that this License applies to the Document. These Warranty
|
||||
Disclaimers are considered to be included by reference in this
|
||||
License, but only as regards disclaiming warranties: any other
|
||||
implication that these Warranty Disclaimers may have is void and has
|
||||
no effect on the meaning of this License.
|
||||
|
||||
#### 2. VERBATIM COPYING
|
||||
|
||||
You may copy and distribute the Document in any medium, either
|
||||
commercially or noncommercially, provided that this License, the
|
||||
copyright notices, and the license notice saying this License applies
|
||||
to the Document are reproduced in all copies, and that you add no
|
||||
other conditions whatsoever to those of this License. You may not use
|
||||
technical measures to obstruct or control the reading or further
|
||||
copying of the copies you make or distribute. However, you may accept
|
||||
compensation in exchange for copies. If you distribute a large enough
|
||||
number of copies you must also follow the conditions in section 3.
|
||||
|
||||
You may also lend copies, under the same conditions stated above, and
|
||||
you may publicly display copies.
|
||||
|
||||
#### 3. COPYING IN QUANTITY
|
||||
|
||||
If you publish printed copies (or copies in media that commonly have
|
||||
printed covers) of the Document, numbering more than 100, and the
|
||||
Document's license notice requires Cover Texts, you must enclose the
|
||||
copies in covers that carry, clearly and legibly, all these Cover
|
||||
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
||||
the back cover. Both covers must also clearly and legibly identify you
|
||||
as the publisher of these copies. The front cover must present the
|
||||
full title with all words of the title equally prominent and visible.
|
||||
You may add other material on the covers in addition. Copying with
|
||||
changes limited to the covers, as long as they preserve the title of
|
||||
the Document and satisfy these conditions, can be treated as verbatim
|
||||
copying in other respects.
|
||||
|
||||
If the required texts for either cover are too voluminous to fit
|
||||
legibly, you should put the first ones listed (as many as fit
|
||||
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||
pages.
|
||||
|
||||
If you publish or distribute Opaque copies of the Document numbering
|
||||
more than 100, you must either include a machine-readable Transparent
|
||||
copy along with each Opaque copy, or state in or with each Opaque copy
|
||||
a computer-network location from which the general network-using
|
||||
public has access to download using public-standard network protocols
|
||||
a complete Transparent copy of the Document, free of added material.
|
||||
If you use the latter option, you must take reasonably prudent steps,
|
||||
when you begin distribution of Opaque copies in quantity, to ensure
|
||||
that this Transparent copy will remain thus accessible at the stated
|
||||
location until at least one year after the last time you distribute an
|
||||
Opaque copy (directly or through your agents or retailers) of that
|
||||
edition to the public.
|
||||
|
||||
It is requested, but not required, that you contact the authors of the
|
||||
Document well before redistributing any large number of copies, to
|
||||
give them a chance to provide you with an updated version of the
|
||||
Document.
|
||||
|
||||
#### 4. MODIFICATIONS
|
||||
|
||||
You may copy and distribute a Modified Version of the Document under
|
||||
the conditions of sections 2 and 3 above, provided that you release
|
||||
the Modified Version under precisely this License, with the Modified
|
||||
Version filling the role of the Document, thus licensing distribution
|
||||
and modification of the Modified Version to whoever possesses a copy
|
||||
of it. In addition, you must do these things in the Modified Version:
|
||||
|
||||
- A. Use in the Title Page (and on the covers, if any) a title
|
||||
distinct from that of the Document, and from those of previous
|
||||
versions (which should, if there were any, be listed in the
|
||||
History section of the Document). You may use the same title as a
|
||||
previous version if the original publisher of that version
|
||||
gives permission.
|
||||
- B. List on the Title Page, as authors, one or more persons or
|
||||
entities responsible for authorship of the modifications in the
|
||||
Modified Version, together with at least five of the principal
|
||||
authors of the Document (all of its principal authors, if it has
|
||||
fewer than five), unless they release you from this requirement.
|
||||
- C. State on the Title page the name of the publisher of the
|
||||
Modified Version, as the publisher.
|
||||
- D. Preserve all the copyright notices of the Document.
|
||||
- E. Add an appropriate copyright notice for your modifications
|
||||
adjacent to the other copyright notices.
|
||||
- F. Include, immediately after the copyright notices, a license
|
||||
notice giving the public permission to use the Modified Version
|
||||
under the terms of this License, in the form shown in the
|
||||
Addendum below.
|
||||
- G. Preserve in that license notice the full lists of Invariant
|
||||
Sections and required Cover Texts given in the Document's
|
||||
license notice.
|
||||
- H. Include an unaltered copy of this License.
|
||||
- I. Preserve the section Entitled "History", Preserve its Title,
|
||||
and add to it an item stating at least the title, year, new
|
||||
authors, and publisher of the Modified Version as given on the
|
||||
Title Page. If there is no section Entitled "History" in the
|
||||
Document, create one stating the title, year, authors, and
|
||||
publisher of the Document as given on its Title Page, then add an
|
||||
item describing the Modified Version as stated in the
|
||||
previous sentence.
|
||||
- J. Preserve the network location, if any, given in the Document
|
||||
for public access to a Transparent copy of the Document, and
|
||||
likewise the network locations given in the Document for previous
|
||||
versions it was based on. These may be placed in the "History"
|
||||
section. You may omit a network location for a work that was
|
||||
published at least four years before the Document itself, or if
|
||||
the original publisher of the version it refers to
|
||||
gives permission.
|
||||
- K. For any section Entitled "Acknowledgements" or "Dedications",
|
||||
Preserve the Title of the section, and preserve in the section all
|
||||
the substance and tone of each of the contributor acknowledgements
|
||||
and/or dedications given therein.
|
||||
- L. Preserve all the Invariant Sections of the Document, unaltered
|
||||
in their text and in their titles. Section numbers or the
|
||||
equivalent are not considered part of the section titles.
|
||||
- M. Delete any section Entitled "Endorsements". Such a section may
|
||||
not be included in the Modified Version.
|
||||
- N. Do not retitle any existing section to be Entitled
|
||||
"Endorsements" or to conflict in title with any Invariant Section.
|
||||
- O. Preserve any Warranty Disclaimers.
|
||||
|
||||
If the Modified Version includes new front-matter sections or
|
||||
appendices that qualify as Secondary Sections and contain no material
|
||||
copied from the Document, you may at your option designate some or all
|
||||
of these sections as invariant. To do this, add their titles to the
|
||||
list of Invariant Sections in the Modified Version's license notice.
|
||||
These titles must be distinct from any other section titles.
|
||||
|
||||
You may add a section Entitled "Endorsements", provided it contains
|
||||
nothing but endorsements of your Modified Version by various
|
||||
parties—for example, statements of peer review or that the text has
|
||||
been approved by an organization as the authoritative definition of a
|
||||
standard.
|
||||
|
||||
You may add a passage of up to five words as a Front-Cover Text, and a
|
||||
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
||||
of Cover Texts in the Modified Version. Only one passage of
|
||||
Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||
through arrangements made by) any one entity. If the Document already
|
||||
includes a cover text for the same cover, previously added by you or
|
||||
by arrangement made by the same entity you are acting on behalf of,
|
||||
you may not add another; but you may replace the old one, on explicit
|
||||
permission from the previous publisher that added the old one.
|
||||
|
||||
The author(s) and publisher(s) of the Document do not by this License
|
||||
give permission to use their names for publicity for or to assert or
|
||||
imply endorsement of any Modified Version.
|
||||
|
||||
#### 5. COMBINING DOCUMENTS
|
||||
|
||||
You may combine the Document with other documents released under this
|
||||
License, under the terms defined in section 4 above for modified
|
||||
versions, provided that you include in the combination all of the
|
||||
Invariant Sections of all of the original documents, unmodified, and
|
||||
list them all as Invariant Sections of your combined work in its
|
||||
license notice, and that you preserve all their Warranty Disclaimers.
|
||||
|
||||
The combined work need only contain one copy of this License, and
|
||||
multiple identical Invariant Sections may be replaced with a single
|
||||
copy. If there are multiple Invariant Sections with the same name but
|
||||
different contents, make the title of each such section unique by
|
||||
adding at the end of it, in parentheses, the name of the original
|
||||
author or publisher of that section if known, or else a unique number.
|
||||
Make the same adjustment to the section titles in the list of
|
||||
Invariant Sections in the license notice of the combined work.
|
||||
|
||||
In the combination, you must combine any sections Entitled "History"
|
||||
in the various original documents, forming one section Entitled
|
||||
"History"; likewise combine any sections Entitled "Acknowledgements",
|
||||
and any sections Entitled "Dedications". You must delete all sections
|
||||
Entitled "Endorsements".
|
||||
|
||||
#### 6. COLLECTIONS OF DOCUMENTS
|
||||
|
||||
You may make a collection consisting of the Document and other
|
||||
documents released under this License, and replace the individual
|
||||
copies of this License in the various documents with a single copy
|
||||
that is included in the collection, provided that you follow the rules
|
||||
of this License for verbatim copying of each of the documents in all
|
||||
other respects.
|
||||
|
||||
You may extract a single document from such a collection, and
|
||||
distribute it individually under this License, provided you insert a
|
||||
copy of this License into the extracted document, and follow this
|
||||
License in all other respects regarding verbatim copying of that
|
||||
document.
|
||||
|
||||
#### 7. AGGREGATION WITH INDEPENDENT WORKS
|
||||
|
||||
A compilation of the Document or its derivatives with other separate
|
||||
and independent documents or works, in or on a volume of a storage or
|
||||
distribution medium, is called an "aggregate" if the copyright
|
||||
resulting from the compilation is not used to limit the legal rights
|
||||
of the compilation's users beyond what the individual works permit.
|
||||
When the Document is included in an aggregate, this License does not
|
||||
apply to the other works in the aggregate which are not themselves
|
||||
derivative works of the Document.
|
||||
|
||||
If the Cover Text requirement of section 3 is applicable to these
|
||||
copies of the Document, then if the Document is less than one half of
|
||||
the entire aggregate, the Document's Cover Texts may be placed on
|
||||
covers that bracket the Document within the aggregate, or the
|
||||
electronic equivalent of covers if the Document is in electronic form.
|
||||
Otherwise they must appear on printed covers that bracket the whole
|
||||
aggregate.
|
||||
|
||||
#### 8. TRANSLATION
|
||||
|
||||
Translation is considered a kind of modification, so you may
|
||||
distribute translations of the Document under the terms of section 4.
|
||||
Replacing Invariant Sections with translations requires special
|
||||
permission from their copyright holders, but you may include
|
||||
translations of some or all Invariant Sections in addition to the
|
||||
original versions of these Invariant Sections. You may include a
|
||||
translation of this License, and all the license notices in the
|
||||
Document, and any Warranty Disclaimers, provided that you also include
|
||||
the original English version of this License and the original versions
|
||||
of those notices and disclaimers. In case of a disagreement between
|
||||
the translation and the original version of this License or a notice
|
||||
or disclaimer, the original version will prevail.
|
||||
|
||||
If a section in the Document is Entitled "Acknowledgements",
|
||||
"Dedications", or "History", the requirement (section 4) to Preserve
|
||||
its Title (section 1) will typically require changing the actual
|
||||
title.
|
||||
|
||||
#### 9. TERMINATION
|
||||
|
||||
You may not copy, modify, sublicense, or distribute the Document
|
||||
except as expressly provided under this License. Any attempt otherwise
|
||||
to copy, modify, sublicense, or distribute it is void, and will
|
||||
automatically terminate your rights under this License.
|
||||
|
||||
However, if you cease all violation of this License, then your license
|
||||
from a particular copyright holder is reinstated (a) provisionally,
|
||||
unless and until the copyright holder explicitly and finally
|
||||
terminates your license, and (b) permanently, if the copyright holder
|
||||
fails to notify you of the violation by some reasonable means prior to
|
||||
60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, receipt of a copy of some or all of the same material does
|
||||
not give you any rights to use it.
|
||||
|
||||
#### 10. FUTURE REVISIONS OF THIS LICENSE
|
||||
|
||||
The Free Software Foundation may publish new, revised versions of the
|
||||
GNU Free Documentation License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in
|
||||
detail to address new problems or concerns. See
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
Each version of the License is given a distinguishing version number.
|
||||
If the Document specifies that a particular numbered version of this
|
||||
License "or any later version" applies to it, you have the option of
|
||||
following the terms and conditions either of that specified version or
|
||||
of any later version that has been published (not as a draft) by the
|
||||
Free Software Foundation. If the Document does not specify a version
|
||||
number of this License, you may choose any version ever published (not
|
||||
as a draft) by the Free Software Foundation. If the Document specifies
|
||||
that a proxy can decide which future versions of this License can be
|
||||
used, that proxy's public statement of acceptance of a version
|
||||
permanently authorizes you to choose that version for the Document.
|
||||
|
||||
#### 11. RELICENSING
|
||||
|
||||
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
|
||||
World Wide Web server that publishes copyrightable works and also
|
||||
provides prominent facilities for anybody to edit those works. A
|
||||
public wiki that anybody can edit is an example of such a server. A
|
||||
"Massive Multiauthor Collaboration" (or "MMC") contained in the site
|
||||
means any set of copyrightable works thus published on the MMC site.
|
||||
|
||||
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
|
||||
license published by Creative Commons Corporation, a not-for-profit
|
||||
corporation with a principal place of business in San Francisco,
|
||||
California, as well as future copyleft versions of that license
|
||||
published by that same organization.
|
||||
|
||||
"Incorporate" means to publish or republish a Document, in whole or in
|
||||
part, as part of another Document.
|
||||
|
||||
An MMC is "eligible for relicensing" if it is licensed under this
|
||||
License, and if all works that were first published under this License
|
||||
somewhere other than this MMC, and subsequently incorporated in whole
|
||||
or in part into the MMC, (1) had no cover texts or invariant sections,
|
||||
and (2) were thus incorporated prior to November 1, 2008.
|
||||
|
||||
The operator of an MMC Site may republish an MMC contained in the site
|
||||
under CC-BY-SA on the same site at any time before August 1, 2009,
|
||||
provided the MMC is eligible for relicensing.
|
||||
|
||||
### ADDENDUM: How to use this License for your documents
|
||||
|
||||
To use this License in a document you have written, include a copy of
|
||||
the License in the document and put the following copyright and
|
||||
license notices just after the title page:
|
||||
|
||||
Copyright (C) YEAR YOUR NAME.
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU Free Documentation License, Version 1.3
|
||||
or any later version published by the Free Software Foundation;
|
||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||
A copy of the license is included in the section entitled "GNU
|
||||
Free Documentation License".
|
||||
|
||||
If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
||||
Texts, replace the "with … Texts." line with this:
|
||||
|
||||
with the Invariant Sections being LIST THEIR TITLES, with the
|
||||
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
|
||||
|
||||
If you have Invariant Sections without Cover Texts, or some other
|
||||
combination of the three, merge those two alternatives to suit the
|
||||
situation.
|
||||
|
||||
If your document contains nontrivial examples of program code, we
|
||||
recommend releasing these examples in parallel under your choice of
|
||||
free software license, such as the GNU General Public License, to
|
||||
permit their use in free software.
|
||||
|
|
@ -1,3 +1,12 @@
|
|||
site_name: Ploopy Adept Trackball
|
||||
site_url: https://ploopyco.github.io/adept-trackball
|
||||
theme: material
|
||||
nav:
|
||||
- 'index.md'
|
||||
- 'assembly-instructions.md'
|
||||
- Appendices:
|
||||
- 'appendices/pcbs.md'
|
||||
- 'appendices/3d-printing.md'
|
||||
- 'appendices/hardware.md'
|
||||
- 'appendices/programming.md'
|
||||
- 'license.md'
|
||||
|
|
|
|||
Loading…
Reference in New Issue