bisq/docs/build.md
Maxim Belkin c5db8ca153
docs/build.md: Emphasize JDK requirements + formatting
* docs/build.md describes how to build Bisq, so steps are part of one
  process. Use bullet points instead of headings to emphasize this fact.
* Use Markdown formatting to indent parts of bullet points for better
  and clearer visual appearance.
* Provide Windows instructions the same way instructions for Linux and
  macOS are provided
2021-04-13 08:03:31 -05:00

1.5 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
    

    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
    cd bisq
    
  3. Pull LFS data

    git lfs pull
    
  4. Build Bisq

    On macOS and Linux, execute:

    ./gradlew build
    

    On Windows:

    gradlew.bat build
    

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 10 and 11 only. JDK 12 and above are not supported. You can find out which version you have with:

    javac -version
    

If your Java version is not 10 or 11, check out scripts in the scripts directory (or online at https://github.com/bisq-network/bisq/tree/master/scripts).

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