From e7a68b30d8e2cef1f5978da2ef5030f94409aa52 Mon Sep 17 00:00:00 2001 From: w0000000t <95026987+w0000000t@users.noreply.github.com> Date: Fri, 26 Nov 2021 21:37:46 +0100 Subject: [PATCH 1/4] made instrucions clearer --- docs/build.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/build.md b/docs/build.md index 6df3d750544..35c3a11153e 100644 --- a/docs/build.md +++ b/docs/build.md @@ -8,6 +8,16 @@ git lfs version ``` + If this returns an error like: + ```git: 'lfs' is not a git command. See 'git --help'. + The most similar command is + log + ``` + + you should first run: + `sudo apt install git-lfs` + in order to actually install the `lfs` package. + You should see the version of Git LFS you installed, for example: ```sh From 474e9a893b6f027277d490d751b904ae5333dd57 Mon Sep 17 00:00:00 2001 From: w0000000t <95026987+w0000000t@users.noreply.github.com> Date: Fri, 26 Nov 2021 21:38:23 +0100 Subject: [PATCH 2/4] Update build.md --- docs/build.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/build.md b/docs/build.md index 35c3a11153e..a6d71e3204c 100644 --- a/docs/build.md +++ b/docs/build.md @@ -9,10 +9,11 @@ ``` If this returns an error like: - ```git: 'lfs' is not a git command. See 'git --help'. + ``` + git: 'lfs' is not a git command. See 'git --help'. The most similar command is log - ``` + ``` you should first run: `sudo apt install git-lfs` From 06f403466f07bc818482b46fa6c0582f0cce2cc9 Mon Sep 17 00:00:00 2001 From: WAT <95026987+w0000000t@users.noreply.github.com> Date: Mon, 20 Dec 2021 11:38:25 +0100 Subject: [PATCH 3/4] added note about the OS where the workaround was needed --- docs/build.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/build.md b/docs/build.md index a6d71e3204c..4ea95dfe66a 100644 --- a/docs/build.md +++ b/docs/build.md @@ -8,16 +8,16 @@ git lfs version ``` - If this returns an error like: + On some distributions (happens with Xubuntu x64 on VM) this might return an error like: ``` git: 'lfs' is not a git command. See 'git --help'. The most similar command is log ``` - you should first run: + if the above happens, you should first run: `sudo apt install git-lfs` - in order to actually install the `lfs` package. + in order to properly install the `lfs` package. You should see the version of Git LFS you installed, for example: From 3441b9abdeb08136e164bcf236ba75825fe94e38 Mon Sep 17 00:00:00 2001 From: WAT <95026987+w0000000t@users.noreply.github.com> Date: Sun, 23 Jan 2022 16:05:27 +0100 Subject: [PATCH 4/4] Add instructions for new IDEA install, fix wording --- docs/idea-import.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/idea-import.md b/docs/idea-import.md index 4d074ebb408..eb8706cdf08 100644 --- a/docs/idea-import.md +++ b/docs/idea-import.md @@ -1,21 +1,21 @@ # Importing Bisq into IntelliJ IDEA -Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2021.1. +Most Bisq contributors use IDEA for development. The following instructions have been tested on IDEA 2021.3. -1. Follow the instructions in [build.md](build.md) to clone and build Bisq at the command line. +1. Follow instructions in [build.md](build.md) to clone and build Bisq at the command line 1. Open IDEA -1. Go to `File -> Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors` and check the `Enable annotation processing` option to enable processing of Lombok annotations (Lombok plugin installed by default since v2020.3) -1. Go to `File -> New -> Project from Existing Sources...` and then select the main Bisq folder to load automatically the related Gradle project -1. If you did not yet setup JDK11 in IntelliJ, go to `File-> Project Structure -> Project` and under the `Project SDK` option locate your JDK11 folder -1. Select JDK 11 for Gradle as well. Go to `File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle` and select the JDK11 location for the Gradle JVM value -1. Go to `Build -> Build Project`. Everything should build cleanly -1. Go to `Run > Edit Configurations... -> Plus (+) icon on the top left -> Application` anf then fill the requested fields as shown below, while using as CLI arguments one of those listed in [dev-setup.md](dev-setup.md): +1. If you are inside a loaded Project, go to `File -> Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors`, else go to `Customize -> All settings... -> Build, Execution, Deployment -> Compiler -> Annotation Processors`, and check the `Enable annotation processing` to enable processing of Lombok annotations (Lombok plugin installed by default since v2020.3) +1. Go to `File -> New -> Project from Existing Sources...` (or `Projects -> Open` from welcome screen) and select the main Bisq folder to automatically load the related Gradle project +1. If you did not yet setup JDK11 in IntelliJ, go to `File -> Project Structure -> Project` and set `SDK` to your JDK11 folder +1. Select JDK11 for Gradle as well: go to `File -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle` and select the JDK11 location in `Gradle JVM` field +1. Run `Build -> Build Project`, the process should complete correctly +1. Go to `Run > Edit Configurations... -> Plus (+) icon on the top left -> Application` and fill the requested fields as shown below, where `CLI arguments` should be taken from those listed in [dev-setup.md](dev-setup.md) (_Alice_ instance in the example): ![edit_configurations.png](edit_configurations.png) -9. Now you should be able to run Bisq by clicking on the _Play_ button or via `Run -> Run 'Bisq Desktop'` -10. If you want to debug the application and execute breakpoints, use `Run -> Debug 'Bisq Desktop'` +9. You should now be able to run Bisq by clicking on the _Play_ button or via `Run -> Run 'Bisq Desktop'` +10. Use `Run -> Debug 'Bisq Desktop'` to debug the application and execute breakpoints -> TIP: If you encounter compilation errors in IDEA related to the `protobuf.*` classes, 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 `other` project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with `./gradlew :other:generateProto`. Once you've done that, run `Build -> Build Project` again and you should have no errors. +> TIP: If you encounter compilation errors in IDEA related to the `protobuf.*` classes, it probably is because you didn't build Bisq at the command line as instructed above. You need to run the `generateProto` task in the `other` project. You can do this via the Gradle tool window in IDEA, or you can do it the command line with `./gradlew :other:generateProto`. After this, run `Build -> Build Project` again, and verify it completes successfully. > > If this does not solve the issue, try to execute `./gradlew clean` and then rebuild the project again.