sqx

Build from source

You only need this to build sqx yourself or publish a release. It requires Go. No C compiler is needed, because sqx uses a pure-Go SQLite.

Build for your own machine

git clone https://github.com/sqx-go/sqx-go.github.io.git sqx
cd sqx
CGO_ENABLED=0 go build -o bin/sqx ./sqx
./bin/sqx version

Build for every platform

./scripts/build_releases.sh v1.2.0

This writes all 10 binaries and a SHA256SUMS file to releases/. The version you pass is what sqx version prints.

Publish a release

  1. Run ./scripts/build_releases.sh vX.Y.Z.
  2. On GitHub, open Releases → Draft a new release and create the tag vX.Y.Z.
  3. Upload every file from releases/, including SHA256SUMS.
  4. Publish. Users can then download from the Releases page, or with …/releases/latest/download/<file>.

Try every example

./scripts/run_examples.sh
./scripts/run_examples.sh --online

The first runs the offline examples; --online also runs the HTTP, DNS and crawler examples. The script prints each command before running it, and keeps its cache and databases in output/.

Build this website

The documentation site is generated from site-src/ by a small Python script that needs only the standard library. It writes the home page to index.html and every other page to site/:

python3 scripts/build_site.py
python3 -m http.server 8000

Then open http://localhost:8000.