bisq/docs/build.md

2.2 KiB

Building Bisq

  1. Install Git LFS

    Bisq uses Git LFS (Large File Storage) to track certain large binary files. Follow the instructions at https://git-lfs.github.com to install it, then run the following to command to verify the installation:

    git lfs version
    

    On some distributions (happens with Xubuntu x64 on VM) this might return an error like:

     git: 'lfs' is not a git command. See 'git --help'.
     The most similar command is
     log
    

    if the above happens, you should first run: sudo apt install git-lfs in order to properly install the lfs package.

    You should see the version of Git LFS you installed, for example:

    git-lfs/2.10.0 (GitHub; darwin amd64; go 1.13.6)
    
  2. Clone Bisq

    git clone https://github.com/bisq-network/bisq
    # if you intend to do testing on the latest release, you can clone the respective branch selectively, without downloading the whole repository
    # for the 1.9.3 release, you would do it like this:
    git clone --branch release/v1.9.3 https://github.com/bisq-network/bisq
    cd bisq
    
  3. Pull LFS data

    git lfs pull
    
  4. Build Bisq

    On macOS and Linux, execute:

    ./gradlew build
    

    On Windows:

    gradlew.bat build
    

    If you prefer to skip tests to speed up the building process, just append -x test to the previous commands.

Important notes

  1. You do not need to install Gradle to build Bisq. The gradlew shell script will install it for you, if necessary.

  2. Bisq currently works with JDK 11 and JDK 15. You can find out which version you have with:

    javac -version
    

If you do not have JDK 11 installed, check out scripts in the scripts directory or download it manually from https://jdk.java.net/archive/.

Running Bisq

Once Bisq is installed, its executables will be available in the root project directory. Run Bisq Desktop as follows:

On macOS and Linux:

./bisq-desktop

On Windows:

bisq-desktop.bat

See also