Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Development Guide #3066

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Development Guide #3066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10f25ad
Development Guide
bart2 Sep 5, 2023
5dc975c
Development Guide
bart2 Sep 5, 2023
2230115
Development Guide
bart2 Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 17 additions & 0 deletions DEVELOPMENT_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# xDrip Development Guide
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, 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 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.
- 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 it to a physical device.
Loading