github.com/sagernet/sing-box@v1.2.7/docs/contributing/environment.md (about)

     1  # Development environment
     2  
     3  #### For the documentation
     4  
     5  ##### Setup
     6  
     7  You need to configure python3 and pip first.
     8  
     9  ```shell
    10  pip install mkdocs-material mkdocs-static-i18n
    11  ```
    12  
    13  ##### Run the site locally
    14  
    15  ```shell
    16  mkdocs serve
    17  ```
    18  
    19  or
    20  
    21  ```shell
    22  python3 -m mkdocs serve
    23  ```
    24  
    25  #### For the project
    26  
    27  By default you have the latest Go installed (currently 1.19), and added `GOPATH/bin` to the PATH environment variable.
    28  
    29  ##### Setup
    30  
    31  ```shell
    32  make fmt_insalll
    33  make lint_install
    34  ```
    35  
    36  This installs the formatting and lint tools, which can be used via `make fmt` and `make lint`.
    37  
    38  For ProtoBuffer changes, you also need `make proto_install` and `make proto`.
    39  
    40  ##### Build binary to the project directory
    41  
    42  ```shell
    43  make
    44  ```
    45  
    46  ##### Install binary to GOPATH/bin
    47  
    48  ```shell
    49  make install
    50  ```