Skip to content

Commit

Permalink
update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
NotQuiteApex committed Dec 28, 2023
1 parent 643c52e commit 14912a8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions firmware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-n
```
These are the only packages necessary for building RP2040 firmware. For more information, visit the [pico-sdk repository](https://github.com/raspberrypi/pico-sdk#quick-start-your-own-project). Equivalent packages exist for most other package managers.

To build the firmware, run the following in the [`firmware`](firmware/) directory:
To build the firmware, run the following in the current directory:
```bash
git submodule update --init --recursive
mkdir build
cd build
cmake ..
make -j4
```
This updates the pico-sdk for the project, along with all of its dependencies. Then, the build is properly started by setting up the build environment, and finally running make to begin the build process with 4 processing cores. You can increase this number as necessary. The final firmware binary will be located at [`firmware/build/jukebox_firmware.uf2`](firmware/build/jukebox_firmware.uf2), move this file onto the board when it's in programming mode (held BOOTSEL) to flash the new firmware.
This updates the pico-sdk for the project, along with all of its dependencies. Then, the build is properly started by setting up the build environment, and finally running make to begin the build process with 4 processing cores. You can increase this number as necessary. The final firmware binary will be located at [`build/jukebox_firmware.uf2`](build/jukebox_firmware.uf2), move this file onto the board when it's in programming mode (held BOOTSEL) to flash the new firmware.

TODO: update above

### Screen Font
The default font is included as [`firmware/misc/JukeBoxFont.png`](firmware/misc/JukeBoxFont.png). It is a monospace, 12x12 pixel font, with the sheet matching IBM Code Page 437. It's ASCII compatible, but with plenty of extra symbols. To export it, run the included [`mkfont.py`](firmware/misc/mkfont.py) script to generate a new `font.h` file. Then, before building the frimware, replace the existing `font.h` with your newly generated font.
The default font is included as [`misc/JukeBoxFont.png`](misc/JukeBoxFont.png). It is a monospace, 12x12 pixel font, with the sheet matching IBM Code Page 437. It's ASCII compatible, but with plenty of extra symbols. To export it, run the included [`misc/mkfont.py`](misc/mkfont.py) script to generate a new `font.h` file. Then, before building the frimware, replace the existing `font.h` with your newly generated font.
2 changes: 1 addition & 1 deletion hardware-pcb/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# JukeBox PCB
Made with KiCad 6.0.7, the PCB is the physical heart of the project. See [`hardware/board`](hardware/board/) directory for the files. You can access the BOM [here](https://www.digikey.com/en/mylists/list/QC5ACPN0J3).
Made with KiCad 6.0.7, the PCB is the physical heart of the project. You can access the BOM [here](https://www.digikey.com/en/mylists/list/QC5ACPN0J3).

Footprints and model for USB4105-GF-A can be found [here](https://www.digikey.com/en/products/detail/gct/usb4105-gf-a/11198441). Footprints for Kailh Choc's can be found [here](https://github.com/daprice/keyswitches.pretty), model can be found [here](https://grabcad.com/library/kailh-low-profile-mechanical-keyboard-switch-1). The model for the Cherry MX Switch can be found [here](https://github.com/ConstantinoSchillebeeckx/cherry-mx-switch).

Expand Down
2 changes: 1 addition & 1 deletion software/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Software
The desktop app that connects to the JukeBox to control its RGB and display, written in Rust for Windows and Linux. See [`software`](software/) directory for the files.
The desktop app that connects to the JukeBox to control its RGB and display, written in Rust for Windows and Linux.

TODO: add gpu support to Rust version through nvml-wrapper crate, AMD Display Library through Rust wrappers, and Intel Graphics Control Library through Rust wrappers.

0 comments on commit 14912a8

Please sign in to comment.