diff --git a/docs/index.md b/docs/index.md index 5b0f6e6..231f93d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,42 @@ -# JoinMarket +# Joinmarket documentation -## Usage +## Contents -If you are new, follow and read the links in the [usage guide](docs/USAGE.md). +1. User guide material -## Installation + a. [Installation guide (BUT use the install script as per README, first)](INSTALL.html) -Follow the [install guide](docs/INSTALL.md). + b. [Main usage guide, covers wallet funding, creation, control, transactions etc.](./USAGE.html) -### More installation guides + c. [Running a yield generator general basics](./YIELDGENERATOR.html) -* [Installation on Windows](docs/INSTALL.md#installation-on-windows). -* [Installation guide for RaspiBlitz](https://github.com/openoms/bitcoin-tutorials/blob/master/joinmarket/README.md). -* [Installation guide for RaspiBolt](https://github.com/kristapsk/raspibolt-extras/blob/master/joinmarket.md). -* [Installation guide for Qubes+Whonix](https://github.com/qubenix/qubes-whonix-bitcoin/blob/master/1_joinmarket.md). -* [Youtube video installation tutorial for Ubuntu](https://www.youtube.com/watch?v=zTCC86IUzWo). + d. [Running JoinmarketQt for coinjoins and wallet control](JOINMARKET-QT-GUIDE.html) + + e. [Important info for takers - how to deal with commitments](./SOURCING-COMMITMENTS.html) + + f. [Important info for makers - how to create and use fidelity bonds](./fidelity-bonds.html) + + g. [How to run the tumbler script (or in Qt) for a good privacy effect](tumblerguide.html) + + h. [How to run the orderbook script locally](orderbook.html) + + i. [How to do payjoins with Joinmarket](./PAYJOIN.html) + + j. [How to use SNICKER features (currently not active)](SNICKER.html) + + +2. More useful for developers, mainly + + a. [How to get a test setup working, with regtest](TESTING.html) + + b. [How to use jmwalletd and the RPC-API to the Joinmarket wallet](JSON-RPC-API-using-jmwalletd.html) + + c. [Some background notes on Joinmarket's architecture (client-daemon etc.)](architecture-notes.html) + + d. [Some notes about project goals and progress, usually not well updated](TODO.html) + +3. Older guides on upgrades/changes that are no longer relevant, ignore: + + a. [Upgrading to p2wpkh/native segwit (which is now default)](NATIVE-SEGWIT-UPGRADE.html) + + b. [Upgrading the IRC config (changed in 2018)](config-irc-update.html)