Add instructions for building with Windows

This commit is contained in:
Cleon Chick 2016-10-08 21:06:52 -04:00 committed by GitHub
parent fc2a404acf
commit 340f4ed066

View file

@ -43,10 +43,9 @@ ColorChord: Embedded
There is work on an embedded version of ColorChord, which avoids floating point operations anywhere in the output pipeline. Though I have made efforts to port it to AVRs, it doesn't seem feasable to operate on AVRs without some shifty tricks which I'd like to avoid, so I have retargeted my efforts to 32-bit systems, such as the STM32F303, STM32F407, and (somehow) the ESP8266. ColorChord Embedded uses a different codebase, located in the [embeddedcommon](embeddedcommon/) and distributed among the various embedded* folders.
Building and Using
------------------
On Linux you'll need the following packages, for Debian/Ubuntu/Mint you'll need the following:
Building with Linux
-----------------
Use `apt-get` to install the following packages for Debian/Ubuntu/Mint:
```
apt-get install libpulse-dev libasound2-dev libx11-dev libxext-dev libxinerama-dev libusb-1.0-0-dev
```
@ -56,8 +55,26 @@ To make colorchord, type:
```
make
```
Building with Windows
-------------------
Then, to run it, use the following syntax:
With either 64bit or 32bit [MSYS2](https://msys2.github.io/) installed, run the _MSYS2 MSYS_ launcher and use `pacman` to set up a MinGW32 toolchain, if you don't have one already:
```
pacman -S mingw-w64-i686-toolchain
```
If you see "`/mingw32 exists in filesystem`", you must temporarily rename or relocate the _mingw32.exe_ file at MSYS2's root folder level and try again. Restore _mingw32.exe_ before moving on.
Next, run the _MSYS2 MinGW 32bit_ launcher to access the toolchain. The previously launched _MSYS_ terminal can be closed.
To make colorchord, navigate to your working copy and type:
```
mingw32-make colorchord.exe
```
Using
-----
To run colorchord, use the following syntax:
```
./colorchord [config file, by default 'default.conf'] [any additional parameters]