Add BUILDING.md

Resolves #65
This commit is contained in:
Trevor Slocum 2019-12-20 07:33:53 -08:00
parent bac2460348
commit 01085498ad
2 changed files with 45 additions and 14 deletions

28
BUILDING.md Normal file
View File

@ -0,0 +1,28 @@
To build Meditation Assistant from source:
# Download
```git clone https://gitlab.com/tslocum/meditationassistant.git```
# Import
Open [Android Studio](https://developer.android.com/studio/), select *Import
project* and choose the folder downloaded above.
# Build
Connect an Android device to your PC using
[ADB](https://developer.android.com/studio/command-line/adb) or start an
[emulated device](https://developer.android.com/studio/run/emulator).
Open the *Build Variants* panel and choose a variant.
Debug variants build quickly, while release variants are optimized.
Variants:
- opensource: F-Droid
- free: Amazon/Google free version
- full: Amazon/Google paid version
Click the green play button labeled *Run selected configuration* to build and
install the application.

View File

@ -19,37 +19,40 @@ Your meditation streak is the number of consecutive days you have recorded at le
session. As your streak grows, "not breaking the chain" becomes quite important. Soon you
will be meditating once a day, even if it's five or ten minutes out of your schedule.
Features
------------
## Features
- Automatically put your device into priority only, alarms only, vibrate or silent mode while meditating
- Choose from several included meditation sounds, or use a sound file of your own
- Play an interval sound at a duration of your choice
- Pause your session and come back to it when you are ready
- Upload sessions to [MediNET](https://gitlab.com/tslocum/medinet)
Donate
------------
## Donate
- [LiberaPay](https://liberapay.com/rocketnine.space) (preferred)
- [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TEP9HT98XK7QA)
Get Support
------------
Feel free to [open an issue](https://gitlab.com/tslocum/meditationassistant/issues) or
contact the developer: trevor@rocketnine.space
## Get Support
[Open an issue](https://gitlab.com/tslocum/meditationassistant/issues) describing your problem.
## Translate
Translate
------------
Translation is handled [online](https://medinet.rocketnine.space/translate/).
Contribute
------------
## Build
See [BUILDING.md](https://gitlab.com/tslocum/meditationassistant/blob/master/BUILDING.md).
## Contribute
1. Read the [GitLab forking workflow guide](https://docs.gitlab.com/ee/workflow/forking_workflow.html).
2. Fork this repository.
3. Commit code changes to your forked repository.
4. Submit a pull request describing your changes.
License
------------
## License
**GNU GPLv3**
This program is free software: you can redistribute it and/or modify