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

## File: README.md

<h3 align="center">
    
 


## What is Bisq?

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

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


## Contribute to Bisq

See [CONTRIBUTING.md](CONTRIBUTING.md) and the [developer docs](docs/README.md).

---

## File: docs/README.md

# Bisq developer docs

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

# Bisq Network Documentation

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

## New Contributors

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

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

## Build

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

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

 - Keep the [Asciidoctor user manual][1] handy as a reference when editing.
 - Install the [Asciidoctor.js Live Preview][2] 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.

[1]: https://asciidoctor.org/docs/user-manual
[2]: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei
[3]: https://docs.bisq.network/user-dao-intro.html
[4]: https://docs.bisq.network
[5]: https://docs.bisq.network/contributor-checklist.html
[6]: https://keybase.io/team/bisq