Skip to content

Commit 4bce1c7

Browse files
committed
Add open source information and links to the hardware and firmware sources
1 parent c3b482e commit 4bce1c7

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

user_guide/docs/images/oshw.svg

Lines changed: 1 addition & 0 deletions
Loading

user_guide/docs/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ You can store and play multiple samples on the Big Honking Button, but to do tha
5757

5858
## Modifying the code
5959

60-
When connected to your computer, Big Honking Button shows up as a small drive named `CIRCUITPY`. In that drive, you should find a file named `code.py`. Big Honking Button runs [CircuitPython](https://circuitpython.org) which means that its firmware is written in the approachable [Python](https://python.org) programming language and you don't need any special knowledge or compilers to make changes to it. So, open up that file in your favorite text editor, we're going to make some changes!
60+
When connected to your computer, Big Honking Button shows up as a small drive named `CIRCUITPY`. In that drive, you should find a file named `code.py`. Big Honking Button runs [CircuitPython][CircuitPython] which means that its firmware is written in the approachable [Python](https://python.org) programming language and you don't need any special knowledge or compilers to make changes to it. So, open up that file in your favorite text editor, we're going to make some changes!
6161

6262
If you don't have a text editor - that's okay! While you could use Notepad (Windows) or TextEdit (Mac), these can sometimes have issues with CircuitPython devices like Big Honking Button. I'd recommend [installing Mu](https://learn.adafruit.com/welcome-to-circuitpython/installing-mu-editor) if you're new to this whole world. You can read more about editing code for CircuitPython in [Adafruit's guide](https://learn.adafruit.com/welcome-to-circuitpython/creating-and-editing-code).
6363

@@ -139,10 +139,21 @@ Updating the firmware requires two steps: Updating CircuitPython and updating Bi
139139
140140
Got a question not answered here? [Reach out](#getting-support-and-help), we'll be happy to help! -->
141141

142+
## Open Source Hardware & Software
143+
144+
Big Honking Button is completely open source and hacking is encouraged.
145+
146+
* The [firmware](https://github.com/theacodes/Winterbloom-Big-Honking-Button/tree/master/firmware) is available under the [MIT License](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/firmware/LICENSE).
147+
* The [hardware design](https://github.com/theacodes/Winterbloom-Big-Honking-Button/tree/master/hardware) is available under the [CC BY-SA 4.0 License](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/hardware/LICENSE) and is designed using [KiCAD](https://kicad.org/) which is free and open-source. You can open the hardware files using KiCAD or you can check out a [PDF of the schematic](https://github.com/theacodes/Winterbloom-Big-Honking-Button/raw/master/hardware/board/board.pdf).
148+
* [CircuitPython][CircuitPython] is available under the [MIT License](https://github.com/adafruit/circuitpython/blob/main/LICENSE).
149+
150+
![Open Source Hardware Association mark](images/oshw.svg){class=oshw} Big Honking Button is [certified open source hardware](https://certification.oshwa.org/us000678.html).
151+
142152

143153
## Acknowledgments and thanks
144154

145155
Big Honking Button would not be possible without the help of the CircuitPython community and Adafruit Industries.
146156

147157

158+
[CircuitPython]: https://circuitpython.org
148159
[discord]: https://discord.gg/UpfqghQ

user_guide/theme/style.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,12 @@ article img.float-right, article img.float-left {
170170
padding: 2em 0.5em;
171171
}
172172

173+
article img.oshw {
174+
display: inline;
175+
width: 100px;
176+
padding: 0;
177+
}
178+
173179
footer {
174180
margin-top: 5em;
175181
margin-bottom: 2em;

0 commit comments

Comments
 (0)