Extract separate docs from main README.md

- Simplify "What is Bisq?" description
 - Extract docs/build.md
 - Extract docs/idea-import.md
 - Introduce docs/README.md index

README.md

@@ -5,48 +5,16 @@
 
 ## What is Bisq?
 
-Bisq is a safe, private and decentralized way to exchange bitcoin for national currencies and other cryptocurrencies. Bisq uses peer-to-peer technology and multi-signature escrow to facilitate trading without the need for a centralized third party exchange. Bisq is non-custodial (never holds your funds), and incorporates a human arbitration system to resolve disputes.
+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.
 
-For more information, see https://bisq.network/intro and for step-by-step getting started instructions, see https://bisq.network/get-started.
+To learn more, see the doc and video at https://bisq.network/intro.
 
 
-## Building Bisq
+## Get started using Bisq
 
-You will need OpenJDK [JDK 10](https://jdk.java.net/10/) installed to complete the following instructions.
+Follow the step-by-step instructions at https://bisq.network/get-started.
-
-1. Clone the Bisq source code and cd into `bisq`
-
-        git clone https://github.com/bisq-network/bisq
-        cd bisq
-
-2. Build Bisq
-
-    You do _not_ need to install Gradle to complete the following command. The `gradlew` shell script will install it for you if necessary.
-
-        ./gradlew build
 
 
-## Running Bisq
+## Contribute to Bisq
-
-With the above build complete, the Bisq executable jar is now available in the `desktop/build/libs/` directory. Run it as follows, replacing `{version}` with the actual version found in the filename:
-
-    java -jar desktop/build/libs/desktop-{version}-all.jar
-
-
-## Importing Bisq into Intellij IDEA
-
-_The following instructions have been tested on IDEA 2018.2_
-
- 1. Open IDEA
- 1. Go to `Help->Edit Custom Properties...`, add a line to the file that reads `idea.max.intellisense.filesize=12500` (to handle Bisq's very large generated `PB.java` Protobuf source file)
- 1. Go to `Preferences->Plugins`. Search for and install the _Lombok_ plugin. When prompted, do not restart IDEA.
- 1. Go to `Preferences->Build, Execution, Deployment->Compiler->Annotation Processors` and check the `Enable annotation processing` option (to enable processing of Lombok annotations)
- 1. Restart IDEA
- 1. Go to `Import Project`, select the `settings.gradle` file and click `Open`
- 1. In the `Import Project from Gradle` screen, check the `Use auto-import` option and click `OK`
- 1. When prompted whether to overwrite the existing `.idea` directory, click `Yes`
- 1. In the `Project` tool window, right click on the root-level `.idea` folder, select `Git->Revert...` and click OK in the dialog that appears (to restore source-controlled `.idea` configuration files that get overwritten during project import)
- 1. Go to `Build->Build Project`. Everything should build cleanly. You should be able to run tests, run `main` methods in any component, etc.
-
-> TIP: If you encounter compilation errors related to the `io.bisq.generated.protobuffer.PB` class, it is probably because you didn't run the full Gradle build above. You need to run the `generateProto` task in the `common` project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with `cd common; ./gradlew generateProto`. Once you've done that, run `Build->Build Project` again and you should have no errors.
 
+See [CONTRIBUTING.md](CONTRIBUTING.md) and the [developer docs](docs#readme).

docs/README.md

@@ -0,0 +1,8 @@
+# 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
+ - [idea-import.md](idea-import.md): Import Bisq sources into IntelliJ IDEA
+ - [DEV_SETUP.md](DEV_SETUP.md): Set up a self-contained local Bisq network on Bitcoin regtest
+
+Looking for user-facing documentation? See https://docs.bisq.network.

docs/build.md

@@ -0,0 +1,29 @@
+# Building Bisq
+
+_You will need [OpenJDK 10](https://jdk.java.net/10/) installed and set up as the default system JDK to complete the following instructions._
+
+
+## Clone
+
+    git clone https://github.com/bisq-network/bisq
+    cd bisq
+
+
+## Build
+
+You do _not_ need to install Gradle to complete the following command. The `gradlew` shell script will install it for you if necessary.
+
+    ./gradlew build
+
+
+## Run
+
+The Bisq executable jar is now available in the `desktop/build/libs/` directory. Run it as follows, replacing `{version}` with the actual version found in the filename:
+
+    java -jar desktop/build/libs/desktop-{version}-all.jar
+
+
+## See also
+
+ - [idea-import.md](idea-import.md)
+ - [dev-setup.md](dev-setup.md)

docs/idea-import.md

@@ -0,0 +1,17 @@
+# Importing Bisq into IntelliJ IDEA
+
+Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2018.2.
+
+ 1. Follow the instructions in [build.md](build.md) to clone and build Bisq at the command line.
+ 1. Open IDEA
+ 1. Go to `Help->Edit Custom Properties...`, add a line to the file that reads `idea.max.intellisense.filesize=12500` (to handle Bisq's very large generated `PB.java` Protobuf source file)
+ 1. Go to `Preferences->Plugins`. Search for and install the _Lombok_ plugin. When prompted, do not restart IDEA.
+ 1. Go to `Preferences->Build, Execution, Deployment->Compiler->Annotation Processors` and check the `Enable annotation processing` option (to enable processing of Lombok annotations)
+ 1. Restart IDEA
+ 1. Go to `Import Project`, select the `settings.gradle` file and click `Open`
+ 1. In the `Import Project from Gradle` screen, check the `Use auto-import` option and click `OK`
+ 1. When prompted whether to overwrite the existing `.idea` directory, click `Yes`
+ 1. In the `Project` tool window, right click on the root-level `.idea` folder, select `Git->Revert...` and click OK in the dialog that appears (to restore source-controlled `.idea` configuration files that get overwritten during project import)
+ 1. Go to `Build->Build Project`. Everything should build cleanly. You should be able to run tests, run `main` methods in any component, etc.
+
+> TIP: If you encounter compilation errors in IDEA related to the `io.bisq.generated.protobuffer.PB` class, it is probably because you didn't build Bisq at the command line as instructed above. You need to run the `generateProto` task in the `common` project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with `./gradlew :common:generateProto`. Once you've done that, run `Build->Build Project` again and you should have no errors.