Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation Update] Update submission guide & Building instructions #1003

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −10
Open

[Documentation Update] Update submission guide & Building instructions #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f2b121
Update submission criteria to be more specific
EnterpriseGoose Nov 21, 2024
0a9a84f
Update ASSEMBLY.md
EnterpriseGoose Nov 21, 2024
22a8f91
Update PULL_REQUEST_TEMPLATE.md
EnterpriseGoose Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Next, make sure you go through **each item** in the following checklist. Delete
- [ ] I am submitting art that...
- [ ] is algorithmically generated (will meaningfully change each time the program is run)
- [ ] is your own work that is not copied from somewhere else
- [ ] is drawable through the editor(does not use outside tools)
- [ ] is drawable through the editor (does not use outside tools)
- [ ] doesn't call `Math.random()` (See the documentation on [randomness](https://github.com/hackclub/blot/blob/main/public/TOOLKIT.md#randomness))
- [ ] is drawable on Blot itself (doesn't have lines overlap more than 5 times)
- [ ] is drawable on Blot itself
- [ ] Doesn't overlap lines more than 5 times
- [ ] Fits in the working area of 125x125mm
- [ ] Doesn't rely on colour to look good
- [ ] Doesn't rely on color or the fill option to look good (and has a toggle if you do use it)

If you used based your art on something else, used a tutorial, or remixed it from something else, please link it here:

Expand Down
6 changes: 3 additions & 3 deletions docs/SUBMISSION_CRITERIA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ Make your own art!

- **Your artwork must be generative.** You should have some variables at the top that are controlled by randomness functions such as `bt.randIntInRange()` that change the artwork

- **Your artwork should be drawable by Blot**, which means it shouldn't excessively cross a certain area multiple times
- **Your artwork should be drawable by Blot**, which means it shouldn't excessively cross a certain area multiple times. The general guideline is that crossing over one point any more than 5 times will rip the paper.

- **Your artwork should not rely on color.** Unfortunately, Blot doesn't have multi-color capabilities yet. Maybe you can be the first to add it!
- **Your artwork should not rely on the fill option.** (This includes color or filling with black) Unfortunately, Blot doesn't understand the fill option yet. Maybe you can be the first to add it! In the mean time, you can use thin stripes to effectively shade an area.

## Submitting
If you feel like your art piece meets these requirements, you can find the submission instructions **[here.](https://github.com/hackclub/blot/blob/main/docs/GET_A_BLOT.md)**
Most artwork takes around 15-20 hours of work to get accepted, so make sure you really polish it before submitting.
Most artwork takes around 15-20 hours of work to get accepted, so make sure you really polish it before submitting.
14 changes: 10 additions & 4 deletions docs/assembly/ASSEMBLY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ And these tools:
- __1 x__ 2.5mm allen key
- __1 x__ 2mm allen key

We'll start by placing the timing belt pulley on to the shaft of the stepper motor.
We'll start by placing the timing belt pulley on to the shaft of the stepper motor. The top of the pulley should be flush with the top of the shaft.

![PXL_20240613_153208987.jpg](./assets/PXL_20240613_153208987.jpg)

Expand All @@ -210,12 +210,14 @@ Secure the motor in place with the M3x10mm screws.

![PXL_20240613_153027084.jpg](./assets/PXL_20240613_153027084.jpg)

Place the rubber feet on the motor.
Place the rubber feet on the leg.

![Screenshot 2024-06-14 at 4.55.06 PM.png](./assets/Screenshot%202024-06-14%20at%204.55.06%20PM.png)

![PXL_20240613_153004363.jpg](./assets/PXL_20240613_153004363.jpg)

Repeat this for the other leg.

We're done!

### Pen Rail
Expand Down Expand Up @@ -517,11 +519,11 @@ The first step to running your Blot is to flash the Blot firmware to the Xiao.

[You can download the firmware here.](https://github.com/hackclub/blot/raw/main/hardware/motor-control-board/firmware/uf2/firmware.ino.uf2)

First hold down the boot button (right button with a small `B` next to it) on your Xiao and then plug it into your computer.
First hold down the boot button (right button with a small `B` next to it) on your Xiao and then plug it into your computer while still holding the button.

<img width="500" src="./assets/xiao-labelled.png" />

It should appear as a drive.
It should appear as a drive, at which point you can release the button. If it doesn't appear, try again until it appears.

Next drop the firmware `.uf2` file onto drive.

Expand All @@ -531,6 +533,8 @@ __Connecting__

To power the Blot plug it into the USB-C brick that comes with your machine. Any USB-C brick that can deliver at least 20W should work. The Blot expects 9V 1A.

Flip the power switch on the board to turn the Blot on.

![PXL_20240710_153733136.jpg](./assets/PXL_20240710_153733136.jpg)

Connect your Blot to the web editor by plugging the Xiao in over USB.
Expand Down Expand Up @@ -670,6 +674,8 @@ Your Blot can draw quite precisely, poor performance is often due to:

- Machine improperly homed.

- Ensure that your blot is all the way in the correct corner when you press set origin. Then ensure your blot starts in that same corner when you run your project.

- Paper sliding.

- To secure the paper you can place one end beneath the Blot.
Expand Down