keyboards/dztech/dz60rgb/keymaps/mekanist/readme.md

   1 # mekanist keymap instructions
   2
   3 ## Dev Environment setup (macOS)
   4
   5 1. Install Homebrew by copy pasting the following into a terminal:
   6     ```
   7     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   8     ```
   9
  10 2. Refer to the [QMK macOS Instructions](https://github.com/qmk/qmk_firmware/blob/master/docs/getting_started_build_tools.md#macos) and install the list of tools using the `brew` command in terminal.
  11
  12 3. While in terminal, issue the following command within the directory you wish to clone qmk_firmware in.
  13
  14     ```
  15     git clone https://github.com/qmk/qmk_firmware.git
  16     ```
  17
  18 ## Creating the mekanist dz60rgb firmware file
  19
  20 1. While in the `qmk_firmware` directory, issue the following command
  21
  22     ```
  23     make git-submodule
  24     ```
  25
  26     This will download the chibi-os submoduled needed to create firmware for ARM based boards such as the dz60rgb.
  27
  28 2. While in the `qmk_firmware` directory, issue the followng command
  29
  30     ```
  31     make dztech/dz60rgb:mekanist
  32     ```
  33
  34     This will result in a file called `dztech_dz60rgb_mekanist.bin` that you can flash onto your board using QMK Toolbox.