Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (16 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

26 lines (16 loc) · 1.6 KB

Hiddify uses Go, make sure that you have the correct version installed before starting development. You can use the following commands to check your installed version:

$ go version

# example response
go version go1.21.1 darwin/arm64

Working with the Go Code

if you're not interested in building/contributing to the Go code, you can skip this section

The Go code for Hiddify can be found in the hiddify-core folder, as a git submodule and in core repository. The entrypoints for the desktop version are available in the hiddify-core/custom folder and for the mobile version they can be found in the hiddify-core/mobile folder.

For the desktop version, we have to compile the Go code into a C shared library. We are providing a Makefile to generate the C shared libraries for all operating systems. The following Make commands will build hiddify-core and copy the resulting output in hiddify-core/bin:

  • make windows-amd64
  • make linux-amd64
  • make macos-universal

For the mobile version, we are using the gomobile tools. The following Make commands will build hiddify-core for Android and iOS and copy the resulting output in hiddify-core/bin:

  • make android
  • make ios