Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 2.75 KB

WindowsSetup.md

File metadata and controls

80 lines (55 loc) · 2.75 KB
Raw

First make sure Cygwin is installed - http://www.cygwin.com/ - 32bit or 64bit is fine. Make sure the following are installed:

  • make
  • git (needed for some compilation info)
  • cmake
  • gcc-core
  • gcc-g++
  • libusb1.0
  • libusb1.0-devel
  • python3
  • ctags (recommended, not required)

Please note, I use cygwin term exclusively for any command line options. Unless mentioned otherwise, use it. Do NOT use CMD or Powershell.

CMake

Also install the Windows version of CMake (3+ is ideal) - Select "Do not add CMake to system PATH". This is in addition to the Cygwin version. This is an easier alternative to installing another C compiler. Add the following lines to your .bashrc, making sure the CMake path is correct:

echo "export wincmake_path='/cygdrive/c/Program Files/CMake/bin'" >> ~/.bashrc

OR

echo "export wincmake_path='/cygdrive/c/Program Files (x86)/CMake/bin'" >> ~/.bashrc

And if you want to run wincmake manually:

echo "alias wincmake=\"PATH='\$wincmake_path':'\${PATH}' cmake -G 'Unix Makefiles'\"" >> ~/.bashrc

Python 3

Along with the Cygwin version of Python 3, you'll also need the Windows version of Python 3. This is due to complications of requiring a non-Cygwin ARM compiler for KLL compilation.

Please install the latest stable version of Python 3.

Serial Drivers

Note Skip this step if you are using Windows 10 or higher, driver is installed automatically.

Install the PJRC Virtual Serial Port Driver. This is necessary to communicate with the keyboards virtual terminal. It is not needed to build, but can be very helpful in debugging.

Next, install the compiler(s) you want.

AVR GCC

AVR is used for "older" chips such as the Teensy 1.0(++), Teensy 2.0(++).

You just need the Atmel AVR 8-bit Toolchain. The latest should be fine, as of writing it was 3.4.3.

Extract the files to a directory, say C:\avr8-gnu-toolchain. Then copy all the folders in that directory to the Cygwin /usr/local directory. Mine is C:\cygwin64\usr\local (You can also just setup the paths, but this is faster/simpler. Might screw up your Cygwin though).

ARM EABI

ARM is used for "newer" chips such as Teensy 3.0/3.1, Infinity Keyboard, McHCK, etc.

Download the latest GNU Tools for Embedded Processors gcc-arm-none-eabi.

Download gcc-arm-none-eabi*win32.zip.

Then extract all the folders/files in the zip to the Cygwin /usr/local directory. Mine is C:\cygwin64\usr\local. Or, you can setup paths using the installer (you have to be more careful, avoid spaces in paths).