github.com/sharovik/devbot@v1.0.1-0.20240308094637-4a0387c40516/documentation/build.md (about)

     1  # Project build
     2  In this documentation you can find the information about project build
     3  
     4  ## Build for current system
     5  In these instructions we assume, that you need to build this project for your current system. For build of the project you need to follow the next steps:
     6  
     7  ``Warning! The following steps will work for MacOs and Linux systems``
     8  1. Clone the latest version of the project to your machine
     9  ``` 
    10  git clone git@github.com:sharovik/devbot.git
    11  ```
    12  2. Run
    13  ```
    14  cp events/defined-events.go.dist events/defined-events.go
    15  ```
    16  3. Go to the project dir and run next command:
    17  ``` 
    18  make build
    19  ```
    20  ## Cross-platform build
    21  If you want to run cross-platform build, please use the following instructions
    22  
    23  ### Before cross-platform build
    24  For cross-platform build I use `karalabe/xgo-latest`. So please before project build do the following steps
    25  1. Install `docker` and `go` to your system
    26  2. Run this command `docker pull karalabe/xgo-latest`
    27  3. Execute this command: `cp events/defined-events.go.dist events/defined-events.go`
    28  4. After that, please run this command: `make build-project-cross-platform`
    29  
    30  This command will build the `devbot` binary for the following OS versions:
    31  #### MacOS
    32  - darwin-386
    33  - darwin-amd64
    34  #### Linux
    35  - linux-386
    36  - linux-amd64
    37  #### Windows
    38  - windows-386
    39  - windows-amd64
    40  
    41  The result of build command you will see in the `bin` directory.