Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/hackclub/blot
Browse files Browse the repository at this point in the history
  • Loading branch information
leomcelroy committed Jul 12, 2024
2 parents 2d4522f + c3fe821 commit fe7e1c6
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,31 @@ There is so much to learn and explore on the programming and the aesthetic side.

<img width="300" src="https://github.com/hackclub/blot/assets/27078897/0ffc0ca8-516b-4f9a-b34e-4f09218e41cd"/>

# Blot Docs

Here are a collection of resources for Blot:

- [Complete documentation of the drawing library in the editor](https://github.com/hackclub/blot/blob/main/docs/DOCUMENTATION.md)
- [Short documentation shown in the Blot editor](https://github.com/hackclub/blot/blob/main/public/TOOLKIT.md)
- [The Blot assembly and operation guide](https://github.com/hackclub/blot/blob/main/docs/assembly/ASSEMBLY.md)
- [The source of truth bill of materials (BOM)](https://github.com/hackclub/blot/blob/main/docs/BOM.toml)
- [Criteria for how to get a Blot and a guide on how to submit a PR](https://github.com/hackclub/blot/blob/main/docs/GET_A_BLOT.md)
- [A guide on how to review Blot submissions](https://github.com/hackclub/blot/blob/main/docs/BLOT_REVIEW.md)
- [A brief guide on how to approve Blot requests for Blot shipments](https://github.com/hackclub/blot/blob/main/docs/APPROVING_BLOT_REQUESTS.md)
- [Information on how we order Blot supplies from our manufacturing partners](https://github.com/hackclub/blot/blob/main/docs/ORDERING_BLOT_KITS.md)
- [The files for the 3D printed parts](https://github.com/hackclub/blot/tree/main/hardware/mechanical/blot-v6)
- [The source files for the control PCB](https://github.com/hackclub/blot/tree/main/hardware/motor-control-board/circuit/controller)
- [The source files for the power delivery PCB](https://github.com/hackclub/blot/tree/main/hardware/motor-control-board/circuit/power-delivery)
- [The firmware for the Blot control board](https://github.com/hackclub/blot/blob/main/hardware/motor-control-board/firmware/firmware.ino)
- [Sample Blot based lesson plan](https://github.com/hackclub/blot/blob/main/docs/lesson/LESSON-PLAN.md)
- [Video of a Blot being assembled](https://www.youtube.com/watch?v=7N-Nu6_oo4I)
- [Video of operating a Blot](https://www.youtube.com/watch?v=qDP5CNjFHJE)
- [Video of making a Blot submission](https://www.youtube.com/watch?v=AmbjNEPuv14)
- [Video Blot promo trailer](https://www.youtube.com/watch?v=d1noJNmfvC0)
- [Video introduction to JavaScript in the context of Blot](https://www.youtube.com/watch?v=3KAan1PzmxA)
- [Video introduction to Blot editor](https://www.youtube.com/watch?v=OZ9KaFr1V_o)
- [Video demonstrating working through a Blot guide](https://www.youtube.com/watch?v=mP4rUdaF8ng)

# What are People Making with Blot

Blot has been in development since January 2023 and was released April 2024. We've had lots of people use the Blot editor and the Blot machine to create visual art, run workshops and as part of interactive installations. Here's a sense of what can be done with Blot.
Expand Down Expand Up @@ -158,31 +183,6 @@ To run the development server:
yarn dev
```

# Blot Docs

Here are a collection of resources for Blot:

- [Complete documentation of the drawing library in the editor](https://github.com/hackclub/blot/blob/main/docs/DOCUMENTATION.md)
- [Short documentation shown in the Blot editor](https://github.com/hackclub/blot/blob/main/public/TOOLKIT.md)
- [The Blot assembly and operation guide](https://github.com/hackclub/blot/blob/main/docs/assembly/ASSEMBLY.md)
- [The source of truth bill of materials (BOM)](https://github.com/hackclub/blot/blob/main/docs/BOM.toml)
- [Criteria for how to get a Blot and a guide on how to submit a PR](https://github.com/hackclub/blot/blob/main/docs/GET_A_BLOT.md)
- [A guide on how to review Blot submissions](https://github.com/hackclub/blot/blob/main/docs/BLOT_REVIEW.md)
- [A brief guide on how to approve Blot requests for Blot shipments](https://github.com/hackclub/blot/blob/main/docs/APPROVING_BLOT_REQUESTS.md)
- [Information on how we order Blot supplies from our manufacturing partners](https://github.com/hackclub/blot/blob/main/docs/ORDERING_BLOT_KITS.md)
- [The files for the 3D printed parts](https://github.com/hackclub/blot/tree/main/hardware/mechanical/blot-v6)
- [The source files for the control PCB](https://github.com/hackclub/blot/tree/main/hardware/motor-control-board/circuit/controller)
- [The source files for the power delivery PCB](https://github.com/hackclub/blot/tree/main/hardware/motor-control-board/circuit/power-delivery)
- [The firmware for the Blot control board](https://github.com/hackclub/blot/blob/main/hardware/motor-control-board/firmware/firmware.ino)
- [Sample Blot based lesson plan](https://github.com/hackclub/blot/blob/main/docs/lesson/LESSON-PLAN.md)
- [Video of a Blot being assembled](https://www.youtube.com/watch?v=7N-Nu6_oo4I)
- [Video of operating a Blot](https://www.youtube.com/watch?v=qDP5CNjFHJE)
- [Video of making a Blot submission](https://www.youtube.com/watch?v=AmbjNEPuv14)
- [Video Blot promo trailer](https://www.youtube.com/watch?v=d1noJNmfvC0)
- [Video introduction to JavaScript in the context of Blot](https://www.youtube.com/watch?v=3KAan1PzmxA)
- [Video introduction to Blot editor](https://www.youtube.com/watch?v=OZ9KaFr1V_o)
- [Video demonstrating working through a Blot guide](https://www.youtube.com/watch?v=mP4rUdaF8ng)

# License
The Hack Club Blot is open source and licensed under the [MIT License](https://github.com/hackclub/blot/LICENSE.md). Fork, remix, and make it your own! Pull requests and other contributions greatly appreciated.

Expand Down

0 comments on commit fe7e1c6

Please sign in to comment.