Building a binary

Binary without keymap

• Make sure you have CRuby (MRI) because "Static type checking" by Steep will be invoked in the build process

• Setup Raspberry Pi Pico C/C++ SDK

  • Follow the instructions on https://github.com/raspberrypi/pico-sdk#quick-start-your-own-project
    • Make sure you have PICO_SDK_PATH environment variable

• Clone the prk_firmware wherever you like

  git clone --recursive https://github.com/picoruby/prk_firmware.git # Don't forget --recursive
  

• Setup (for the first time only)

  cd prk_firmware/
  ./setup.sh
  

• Build

  cd build/
  cmake ..
  make
  

  Now you should have prk_firmware-[version]-[date]-[hash].uf2 file in prk_firmware/build/ directory.

Binary with keymap (without mass storage)

You may want PRK Firmware not to be a mass storage device in case that your employer doesn't allow you to bring a USB memory 🙈

If so, you can build a binary including your keymap.rb in this way:

• Clone a keymap repository, for example, "meishi2" which is a 2x2 matrix card-shaped keyboard in keyboards directory

  cd prk_firmware/keyboards
  git clone https://github.com/picoruby/prk_meishi2.git
  

• (Optional) Edit prk_meishi2/keymap.rb as you wish

• Build with cmake and make

  cd prk_firmware/keyboards/prk_meishi2/build
  cmake -DPRK_NO_MSC=1 ../../..
  make
  

  (Defining PRK_NO_MSC macro is going to avoid implementing the mass storage feature)

  Now you should have prk_firmware-[version]-[date]-no_msc.uf2 file in prk_firmware/keyboards/prk_meishi2/build/ directory which includes your keymap in code.

Build with Docker

You can also use docker to build:

docker build -o keyboards --build-arg KEYBOARD=prk_meishi2 .