Skip to content
Branch: master
Clone or download
fdidron Merge pull request #4 from lee-dohm/patch-1
Update Linux install wiki links to new location
Latest commit cf8fda3 May 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cli Initial commit May 14, 2019
dist Initial commit May 14, 2019
ui Initial commit May 14, 2019
wally Initial commit May 14, 2019
.gitignore Initial commit May 14, 2019
LICENCE.md Initial commit May 14, 2019
README.md Update Linux install wiki links to new location May 20, 2019
build.linux.sh Initial commit May 14, 2019
build.osx.sh Initial commit May 14, 2019
build.win.bat Initial commit May 14, 2019
main.go Initial commit May 14, 2019
ui.go Initial commit May 14, 2019
ui_dev.go Initial commit May 14, 2019
ui_dist.go Initial commit May 14, 2019

README.md

Wally

Flash your ZSA Keyboard the EZ way.

Getting started

Wally comes in two flavors, a GUI and a CLI app. Download the application for your favorite plateform from the release page.

Note for Linux users, follow the instructions from our wiki page 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.

Wally is built using Go at its core and Preact for the UI. The binding between core and ui happens using a fork of the webview package. This guide assumes you have a proper Go and NodeJS development environment running.

Installing dev dependencies

Wally is compatible with Windows, Linux, and macOS. Develping using each plateform requires some extra setup:

Windows

  1. Install TDM GCC
  2. Setup pkg-config - see http://www.mingw.org/wiki/FAQ "How do I get pkg-config installed?"
  3. Grab and install the latest version of libusb from here

Linux

Follow the instructions from our wiki page

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

Windows

Run build.win.bat

Linux

Run build.linux.sh

Mac OS

Run build.osx.sh

You can’t perform that action at this time.