proton-mail-android/README.md

35 lines
1.6 KiB
Markdown
Raw Normal View History

2020-04-16 15:44:53 +00:00
# ProtonMail for Android
Copyright (c) 2020 Proton Technologies AG
## License
The code and data files in this distribution are licensed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/> for a copy of this license.
See [LICENSE](LICENSE) file
## Setup
2020-04-21 17:26:55 +00:00
The most straightforward way to build and run this application is to:
2020-04-16 15:44:53 +00:00
- Install Android Studio: https://developer.android.com/studio/install
2020-04-21 17:26:55 +00:00
- Clone the repository. You have two options:
- Use the `Project from version control` in Android Studio, or
- Use the `git clone` command and import it into Android Studio
- Build and run the app directly in Android Studio
2020-04-16 15:44:53 +00:00
2020-04-21 17:26:55 +00:00
Alternatively, if you want to build the app directly from the command line (or using a different IDE, etc.), you will first need to install the command line tools from: https://developer.android.com/studio#cmdline-tools. Then you will need to install the SDK using the `sdkmanager` tool. After cloning the repository with `git clone` you will need to edit the `local.properties` file so that it points to the location of the SDK. Depending on which operating systems you use, the location of the SDK is usually:
2020-04-16 15:44:53 +00:00
- Windows: `C:\Users\<username>\AppData\Local\Android\sdk`
- MacOS: `/Users/<username>/Library/Android/Sdk/`
- Linux: `/Users/<username>/Android/Sdk/`
2020-04-21 17:26:55 +00:00
Then, go to the apps root directory in the command line tool and run:
2020-04-16 15:44:53 +00:00
- `./gradlew assembleBetaDebug`
- `adb install ./app/build/outputs/apk/beta/debug/ProtonMail-Android-1.XX.X-beta-debug.apk`
Copyright (c) 2020 Proton Technologies AG