Build from source¶

You need: Go.

For the faster -cgo flavour you also need a C compiler: Xcode Command Line Tools on macOS, build-essential on Debian and Ubuntu, MSYS2 or MinGW on Windows.

Install the command¶

go install -tags sqlite_fts5 github.com/wuweidict/wudict@latest

go install github.com/wuweidict/wudict@latest

Both commands produce a wudict that works. The tag chooses the SQLite engine and the Speex decoder, nothing else.

On a machine without a C toolchain, the -tags sqlite_fts5 command does not fail. It falls back to the pure-Go driver.

From a clone¶

The Makefile is the interface. Every action has a target.

make build     # native build, cgo flavour, into ./wudict
make install   # into GOBIN
make check     # tidy, vet and all tests
make help      # every target, with a description

Run make check before you propose a change.

The API document¶

The HTTP contract is one OpenAPI file, internal/server/web/openapi.yaml, embedded into the binary and served at /api/openapi.yaml.

make api-test   # assert it matches the server's routes (also part of make test)
make api-lint   # validate it (needs Node, through npx)
make api-open   # render it and open it - one offline HTML file in dist/

make api-test is the gate. It walks the document against the route table in both directions, so an endpoint cannot be added, renamed or dropped without the document following it. api-lint and api-ui need the network on first run; make check never does.

The documentation site¶

This site is built by Zensical from pages/, and published to GitHub Pages by .github/workflows/docs.yml on every push to master that touches it.

pip install -r pages/requirements.txt
make docs         # into pages/site, warnings are errors
make docs-serve   # preview at localhost:8000
make docs-clean   # remove the output, the cache and the copied explorer

The generator is pinned in pages/requirements.txt. Zensical is pre-1.0, so an unpinned install would build the published site with a version nobody tested.

make docs renders the API explorer into pages/docs/api/ before it builds, so the explorer is part of the site and appears in the local preview too. That folder is generated, and git ignores it.

The build runs with --strict, which turns a broken link or a missing anchor into a failed build. Without that flag Zensical reports the issue and still exits 0.

Release builds¶

make cross

This produces the pure-Go binaries for macOS, Linux and Windows into dist/ - the same set the automated builds produce.

make mac-app          # wuDict.app into dist/
make mac-app-install  # and into ~/Applications
make win-installer    # the Windows installer (needs Inno Setup 6.3 or newer)

Android¶

make android-go     # cross-compile the server into the app (needs the Android NDK)
make apk            # build the APK (needs the Android SDK)

make android-go builds the cgo flavour, which needs the NDK. Without it, use make android-go-purego. That fallback has no Speex audio on the device.

The Android app is a WebView shell that runs the same server binary. It adds no Go code and no build tags.

Two flavours¶

One source tree builds two APKs. They differ only in how a dictionary reaches the device.

The released wudict-android-arm64.apk is the foss flavour, which is what the Android app describes. make apk-verify asserts that the play build still declares no storage permission.

Verify¶

./wudict --version