Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.84 KB

developing-tkeel.md

File metadata and controls

45 lines (29 loc) · 1.84 KB

Developing TKeel

Setup TKeel development environment

There are several options for getting an environment up and running for TKeel development:

Cloning the repo

cd $GOPATH/src
mkdir -p github.com/tkeel-io/tkeel
git clone https://github.com/tkeel-io/tkeel.git github.com/tkeel-io/tkeel

Build the TKeel binaries

You can build TKeel binaries with the make tool.

On Windows, the make commands must be run under git-bash.

These instructions also require that a make alias has been created for mingw32-make.exe according to the setup instructions.

  • When running make, you need to be at the root of the tkeel/tkeel repo directory, for example: $GOPATH/src/github.com/tkeel-io/tkeel.

  • Once built, the release binaries will be found in ./dist/{os}_{arch}/release/, where {os}_{arch} is your current OS and architecture.

    For example, running make build on an Intel-based MacOS will generate the directory ./dist/darwin_amd64/release.

  • To build for your current local environment:

    cd $GOPATH/src/github.com/tkeel-io/tkeel/
make build

  • To cross-compile for a different platform:

    make build GOOS=windows GOARCH=amd64

    For example, developers on Windows who prefer to develop in WSL2 can use the Linux development environment to cross-compile binaries like tkeeld.exe that run on Windows natively.