blob: aaba053cacba32eac17420c9284cf4e7ed3cda6b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# Wally
Flash your [ZSA Keyboard](https://ergodox-ez.com) the EZ way.
ℹ️ Windows users: [There's a new version of Wally](https://github.com/zsa/wally-win/) rewritten from the ground up using native technologies.
ErgoDox EZ users: [Teensy Loader](https://www.pjrc.com/teensy/loader.html) will still work for flashing your ErgoDox EZ (as will Wally — you've got options!).
## Getting started
⚠️ Warning starting from firmware v19, Wally needs to be updated to v2.1.0 in order to detect your keyboard. Linux users should update their udev rules using the latest version from [the wiki](https://github.com/zsa/wally/wiki/Live-training-on-Linux).
Wally comes in two flavors, a GUI and a CLI app.
Download the application for your favorite platform from the relevant release page: [GUI](https://github.com/zsa/wally/releases) / [CLI](https://github.com/zsa/wally-cli/releases).
Note for Linux users, follow the instructions from our [wiki page](https://github.com/zsa/wally/wiki/Linux-install) before running the application.
Note for Mac OS users, the CLI requires libusb to be installed: `brew install libusb`
## Contributing
The following instructions apply only to those who wish to actively _develop_ Wally and contribute new features or bugfixes to this open-source project. If you simply want to flash your board with some fresh firmware, see above.
Found a bug? Open an [issue here](https://github.com/zsa/wally/issues).
Wally is built using [Go](https://golang.org/) at its core and [Preact](https://preactjs.com/) for the UI. The binding between core and UI happens using a [fork](https://github.com/fdidron/webview) of the [webview package](https://github.com/zserge/webview). This guide assumes you have a proper Go and NodeJS development environment running.
### Installing dev dependencies
Wally is compatible with Windows, Linux, and macOS. Developing using each platform requires some extra setup:
#### Windows
1. Install [TDM GCC](http://tdm-gcc.tdragon.net/download)
2. Setup pkg-config - see [http://www.mingw.org/wiki/FAQ](http://www.mingw.org/wiki/FAQ) "How do I get pkg-config installed?"
3. Grab and install the latest version of libusb [from here](http://sourceforge.net/projects/libusb/files/libusb-1.0/)
#### Linux
Follow the instructions from our [wiki page](https://github.com/zsa/wally/wiki/Linux-install) or run the `install.linux.sh`.
`install.linux.sh` should install all needed packages according to your x86 distribution.
If you try to get wally working on a RaspberryPi, which has an ARM architecture, the script will compile the `wally-cli` for you and set it as alias in your bash.
Installing should be as easy as running `./install.linux.sh`
#### macOS
Install libusb using `brew`:
```
brew install libusb
```
### Serve the UI locally
From the `ui` folder run `npm run serve` or `yarn dev` to run a webpack dev server locally on port `8080`.
### Compile a dev build
Run the following:
```
go build -tags dev -o wally
```
This build will bind its UI with the local webpack server.
### Compile the CLI
Run the following:
```
go build cli/main.go -o wally-cli
```
### Compile a release build
#### Pre requisites for all OS
1. Install [dep](https://github.com/golang/dep) and run the command `dep ensure` to grab all the go dependencies.
2. Install [go-bindata](https://github.com/jteeuwen/go-bindata) by running the command `go get -u github.com/jteeuwen/go-bindata/...`.
3. Install `cross-env` and `webpack` by running the command `yarn global add cross-env webpack` or `npm i -g cross-env webpack`.
#### Windows
Run `build.win.bat`
#### Linux
Run `build.linux.sh`
#### Mac OS
1. Install libusb using `brew`: `brew install libusb`.
2. Install `upx` using `brew`: `brew install upx`.
3. Run `build.osx.sh`
The wally gui and cli apps should be in `./dist/osx` .
Note: the GUI app won't include libusb so it needs to be installed on the computer running it. To embed libusb into the binary, install [dylibbundler](https://github.com/auriamg/macdylibbundler/) and run:
`dylibbundler -of -b -x ./dist/osx/Wally.app/Contents/MacOS/Wally -d ./dist/osx/Wally.app/Contents/libs/`
|
