black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-10 02:53:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
sing-box/docs/contributing/environment.md
世界 561a9e5275
Update documentation
2022-08-28 00:23:41 +08:00

776 B
Raw Blame History

Development environment

For the documentation

Setup

You need to configure python3 and pip first.

pip install mkdocs-material mkdocs-static-i18n
Run the site locally
mkdocs serve

or

python3 -m mkdocs serve

For the project

By default you have the latest Go installed (currently 1.19), and added GOPATH/bin to the PATH environment variable.

Setup
make fmt_insalll
make lint_install

This installs the formatting and lint tools, which can be used via make fmt and make lint.

For ProtoBuffer changes, you also need make proto_install and make proto.

Build binary to the project directory
make
Install binary to GOPATH/bin
make install