bisq Documentation

1. Project Overview & Quickstart (bisq-network/bisq) Copy Chapter

File: README.md Copy Chapter

What is Bisq? Copy Chapter

Bisq is a safe, private and decentralized way to exchange bitcoin for national currencies and other digital assets. Bisq uses peer-to-peer networking and multi-signature escrow to facilitate trading without a third party. Bisq is non-custodial and incorporates a human arbitration system to resolve disputes.

To learn more, see the doc and video at https://bisq.network/intro.

Get started using Bisq Copy Chapter

Follow the step-by-step instructions at https://bisq.network/get-started.

Contribute to Bisq Copy Chapter

See CONTRIBUTING.md and the developer docs.

File: docs/README.md Copy Chapter

Bisq developer docs

• CONTRIBUTING.md: Understand Bisq's contribution and compensation guidelines
• build.md: Build and run Bisq at the command line
• specifications: Authoritative domain behaviour and invariants
• dependency-signature-report.md: Dependency PGP signature verification status
• release-checklist.md: Complete task list for a release: version, bundled data
  files, activation heights, build, signatures, publication
• release-process.md: Manual build, signing and upload steps of a release
• reproducible-builds: Reproducible release-build goals, usage, technical details, and platform notes
• idea-import.md: Import Bisq sources into IntelliJ IDEA
• Makefile: (new) Set up a self-contained local Bisq network on Bitcoin regtest
• dev-setup.md: (deprecated) Set up a self-contained local Bisq network on Bitcoin regtest
• dao-setup.md: (deprecated) Set up a complete Bisq DAO development environment
• burning-man-address-list.md: Understand the versioned Burning Man DPT receiver
  allowlist
• burningman/filter-controlled-btc-fee-receiver-routing.md:
  Filter-controlled BTC trade-fee receiver routing for Burning Man
• testing.md: Learn about the Bisq testing process and how you can contribute.

Looking for user-facing documentation? See https://bisq.wiki.

2. Official Technical Reference & Guides (bisq-network/bisq-docs) Copy Chapter

Bisq Network Documentation

AsciiDoc sources for the docs hosted at https://docs.bisq.network.

New Contributors Copy Chapter

Bisq's decentralized governance structure makes documentation especially important. If you're interested in contributing:

• Take a look at existing docs to get a feel for the general approach to format, tone, and detail
• Look through our Contributor's Checklist for a background on how we work and conventions (e.g., proper git commit messages)
• Correspond with existing contributors on Keybase to discuss your ideas or determine where help is most needed

Build Copy Chapter

To build locally, run ./gradlew build (gradlew.bat build --project-cache-dir=../cache on Windows) and then open build/asciidoc/html5/index.html in your browser.

Deploy Copy Chapter

Commits pushed to the master branch of this repository are automatically built and deployed via Netlify at https://app.netlify.com/sites/bisq-network-docs (permission required).

Writing Tips Copy Chapter

• Keep the Asciidoctor user manual handy as a reference when editing.
• Install the Asciidoctor.js Live Preview Chrome extension for instant in-browser rendering of .adoc files. This avoids the need to run gradle build and then refresh your browser to see the results of your changes.