From 10f25adfc76618199c8b9d62a8bd49f9c6246bca Mon Sep 17 00:00:00 2001 From: bart2 Date: Mon, 4 Sep 2023 22:25:04 -0700 Subject: [PATCH 1/3] Development Guide --- CONTRIBUTING.md | 2 ++ DEVELOPMENT_GUIDE.md | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 DEVELOPMENT_GUIDE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e9024e18f..492ca25424 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,8 @@ Patches are welcomed! To ensure the best all round results they need be a good f The best way to get patches accepted is to discuss your ideas with project maintainers using [Discussions](https://github.com/NightscoutFoundation/xDrip/discussions) prior to implementation and discuss how to structure things so that they can fit well within the project and also the rationale for the change. +Check the [development guide](DEVELOPMENT_GUIDE.md) on how to setup your dev environment. + #### Copyright of submitted contributions Any submitted patches and pull requests must either be the original work of the submitter or be available under a suitable open source license which is compatible with inclusion in a GPL licensed project. diff --git a/DEVELOPMENT_GUIDE.md b/DEVELOPMENT_GUIDE.md new file mode 100644 index 0000000000..83dd6826e1 --- /dev/null +++ b/DEVELOPMENT_GUIDE.md @@ -0,0 +1,19 @@ +# xDrip Development Guide +The following steps describe how to setup a development environment required to build xDrip. +- Fork https://github.com/NightscoutFoundation/xDrip in GitHub. +- Download, install and launch the latest Android Studio from https://developer.android.com/studio. +- In the startup menu, click `Get from VCS`. +- Select GitHub in the left panel and then click `Log In via GitHub...`. +- Click `Authorize in GitHub` on the newly opened page. +- You should now see a list of your GitHub project, including newly forked `xDrip`. +Select it and click `Clone`. +- You will probably see `Unsupported Java` error. We need to use an older JDK version +to be able to build xDrip: + - Open following menu: *File* -> *Settings* -> *Build, Execution, Deployment* -> *Build Tools* -> *Gradle*. + - In `Gradle JDK` dropdown select `Download JDK...`. + - In `Version:` select `11`, leave the remaining options unchanged. + - Click `Download`, click `Apply`. + - Close the settings window. + - Restart Android Studio. + +You should now be able to build xDrip and run it in an emulator or deploy to a physical device. \ No newline at end of file From 5dc975c526c49d57a203473df68070bcf6fd1dfe Mon Sep 17 00:00:00 2001 From: bart2 Date: Mon, 4 Sep 2023 22:29:37 -0700 Subject: [PATCH 2/3] Development Guide --- DEVELOPMENT_GUIDE.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/DEVELOPMENT_GUIDE.md b/DEVELOPMENT_GUIDE.md index 83dd6826e1..15832ce369 100644 --- a/DEVELOPMENT_GUIDE.md +++ b/DEVELOPMENT_GUIDE.md @@ -1,19 +1,17 @@ # xDrip Development Guide -The following steps describe how to setup a development environment required to build xDrip. -- Fork https://github.com/NightscoutFoundation/xDrip in GitHub. -- Download, install and launch the latest Android Studio from https://developer.android.com/studio. +The following steps describe how to set up a development environment required to build xDrip. +- Fork [NightscoutFoundation/xDrip](https://github.com/NightscoutFoundation/xDrip) on GitHub. +- Download, install, and launch the latest Android Studio from [Android Studio Official Site](https://developer.android.com/studio). - In the startup menu, click `Get from VCS`. -- Select GitHub in the left panel and then click `Log In via GitHub...`. +- Select GitHub in the left panel, then click `Log In via GitHub...`. - Click `Authorize in GitHub` on the newly opened page. -- You should now see a list of your GitHub project, including newly forked `xDrip`. -Select it and click `Clone`. -- You will probably see `Unsupported Java` error. We need to use an older JDK version -to be able to build xDrip: - - Open following menu: *File* -> *Settings* -> *Build, Execution, Deployment* -> *Build Tools* -> *Gradle*. - - In `Gradle JDK` dropdown select `Download JDK...`. - - In `Version:` select `11`, leave the remaining options unchanged. - - Click `Download`, click `Apply`. - - Close the settings window. - - Restart Android Studio. +- You should now see a list of your GitHub projects, including the newly forked `xDrip`. Select it and click `Clone`. +- You may encounter an `Unsupported Java` error. To build xDrip, use an older JDK version: + - Open the following menu: *File* -> *Settings* -> *Build, Execution, Deployment* -> *Build Tools* -> *Gradle*. + - In the `Gradle JDK` dropdown, select `Download JDK...`. + - For `Version:`, select `11`; leave the remaining options unchanged. + - Click `Download`, then click `Apply`. + - Close the settings window. + - Restart Android Studio. -You should now be able to build xDrip and run it in an emulator or deploy to a physical device. \ No newline at end of file +You should now be able to build xDrip and run it in an emulator or deploy it to a physical device. From 223011518767bbf3a16d079b46b137f8fb06ef23 Mon Sep 17 00:00:00 2001 From: bart2 Date: Mon, 4 Sep 2023 22:31:25 -0700 Subject: [PATCH 3/3] Development Guide --- DEVELOPMENT_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPMENT_GUIDE.md b/DEVELOPMENT_GUIDE.md index 15832ce369..f688cfb2cb 100644 --- a/DEVELOPMENT_GUIDE.md +++ b/DEVELOPMENT_GUIDE.md @@ -6,7 +6,7 @@ The following steps describe how to set up a development environment required to - Select GitHub in the left panel, then click `Log In via GitHub...`. - Click `Authorize in GitHub` on the newly opened page. - You should now see a list of your GitHub projects, including the newly forked `xDrip`. Select it and click `Clone`. -- You may encounter an `Unsupported Java` error. To build xDrip, use an older JDK version: +- You may encounter an `Unsupported Java` error. To be able to build xDrip, an older JDK version is required: - Open the following menu: *File* -> *Settings* -> *Build, Execution, Deployment* -> *Build Tools* -> *Gradle*. - In the `Gradle JDK` dropdown, select `Download JDK...`. - For `Version:`, select `11`; leave the remaining options unchanged.