Skip to content

Commit 23a41b6

Browse files
cbeamscbeams
committed
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
1 parent 8dccf04 commit 23a41b6

File tree

4 files changed

+60
-38
lines changed

4 files changed

+60
-38
lines changed

‎README.md

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,16 @@
55

66
## What is Bisq?
77

8-
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.
8+
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.
99

10-
For more information, see https://bisq.network/intro and for step-by-step getting started instructions, see https://bisq.network/get-started.
10+
To learn more, see the doc and video at https://bisq.network/intro.
1111

1212

13-
## Building Bisq
13+
## Get started using Bisq
1414

15-
You will need OpenJDK [JDK 10](https://jdk.java.net/10/) installed to complete the following instructions.
15+
Follow the step-by-step instructions at https://bisq.network/get-started.
1616

17-
1. Clone the Bisq source code and cd into `bisq`
1817

19-
git clone https://github.com/bisq-network/bisq
20-
cd bisq
21-
22-
2. Build Bisq
23-
24-
You do _not_ need to install Gradle to complete the following command. The `gradlew` shell script will install it for you if necessary.
25-
26-
./gradlew build
27-
28-
29-
## Running Bisq
30-
31-
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:
32-
33-
java -jar desktop/build/libs/desktop-{version}-all.jar
34-
35-
36-
## Importing Bisq into Intellij IDEA
37-
38-
_The following instructions have been tested on IDEA 2018.2_
39-
40-
1. Open IDEA
41-
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)
42-
1. Go to `Preferences->Plugins`. Search for and install the _Lombok_ plugin. When prompted, do not restart IDEA.
43-
1. Go to `Preferences->Build, Execution, Deployment->Compiler->Annotation Processors` and check the `Enable annotation processing` option (to enable processing of Lombok annotations)
44-
1. Restart IDEA
45-
1. Go to `Import Project`, select the `settings.gradle` file and click `Open`
46-
1. In the `Import Project from Gradle` screen, check the `Use auto-import` option and click `OK`
47-
1. When prompted whether to overwrite the existing `.idea` directory, click `Yes`
48-
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)
49-
1. Go to `Build->Build Project`. Everything should build cleanly. You should be able to run tests, run `main` methods in any component, etc.
50-
51-
> 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.
18+
## Contribute to Bisq
5219

20+
See [CONTRIBUTING.md](CONTRIBUTING.md) and the [developer docs](docs#readme).

‎docs/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Bisq developer docs
2+
3+
- [CONTRIBUTING.md](../CONTRIBUTING.md): Understand Bisq's contribution and compensation guidelines
4+
- [build.md](build.md): Build and run Bisq at the command line
5+
- [idea-import.md](idea-import.md): Import Bisq sources into IntelliJ IDEA
6+
- [DEV_SETUP.md](DEV_SETUP.md): Set up a self-contained local Bisq network on Bitcoin regtest
7+
8+
Looking for user-facing documentation? See https://docs.bisq.network.

‎docs/build.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Building Bisq
2+
3+
_You will need [OpenJDK 10](https://jdk.java.net/10/) installed and set up as the default system JDK to complete the following instructions._
4+
5+
6+
## Clone
7+
8+
git clone https://github.com/bisq-network/bisq
9+
cd bisq
10+
11+
12+
## Build
13+
14+
You do _not_ need to install Gradle to complete the following command. The `gradlew` shell script will install it for you if necessary.
15+
16+
./gradlew build
17+
18+
19+
## Run
20+
21+
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:
22+
23+
java -jar desktop/build/libs/desktop-{version}-all.jar
24+
25+
26+
## See also
27+
28+
- [idea-import.md](idea-import.md)
29+
- [dev-setup.md](dev-setup.md)

‎docs/idea-import.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Importing Bisq into IntelliJ IDEA
2+
3+
Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2018.2.
4+
5+
1. Follow the instructions in [build.md](build.md) to clone and build Bisq at the command line.
6+
1. Open IDEA
7+
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)
8+
1. Go to `Preferences->Plugins`. Search for and install the _Lombok_ plugin. When prompted, do not restart IDEA.
9+
1. Go to `Preferences->Build, Execution, Deployment->Compiler->Annotation Processors` and check the `Enable annotation processing` option (to enable processing of Lombok annotations)
10+
1. Restart IDEA
11+
1. Go to `Import Project`, select the `settings.gradle` file and click `Open`
12+
1. In the `Import Project from Gradle` screen, check the `Use auto-import` option and click `OK`
13+
1. When prompted whether to overwrite the existing `.idea` directory, click `Yes`
14+
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)
15+
1. Go to `Build->Build Project`. Everything should build cleanly. You should be able to run tests, run `main` methods in any component, etc.
16+
17+
> 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.

0 commit comments

Comments
 (0)