Skip to content

Commit

Permalink
docs: include command-line instructions to build apk
Browse files Browse the repository at this point in the history
  • Loading branch information
Irineu333 committed Sep 29, 2023
1 parent 949fcc3 commit da5e851
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
1 change: 0 additions & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,28 @@ A open source screen reader for android.
## Build
In development, choose the *debug build type*, because for the *release build type*, it's necessary to create a [keystore](https://developer.android.com/training/articles/keystore) and specify its properties in the `keystore.properties` file (use `keystore.properties.example` as a base).

### IDE
To build you need [Android Studio](https://developer.android.com/studio/releases) (Flamingo or later).
### Android Studio

1. Clone the repository to your local machine.
2. Open the project in the IDE.
3. Run the **app** module.
1. Download and install [Android Studio](https://developer.android.com/studio).
2. Clone the repository to your local machine.
3. Open the project in the Android Studio.
4. Run the **app** module.

### IntelliJ IDEA

1. Download and install [IntelliJ IDEA](https://www.jetbrains.com/idea/).
2. Clone the repository to your local machine.
3. Open the project in the IntelliJ IDEA.
4. Run the **app** module.

### Command line
1. Download and install [JDK 17](https://www.oracle.com/java/technologies/downloads/#java17) or newer.
2. Download and install [Android Command Line Tools](https://developer.android.com/studio#command-tools).
3. Set android sdk path on `ANDROID_HOME` environment variable.
4. Clone the repository to your local machine.
5. Open the project in the terminal with `cd path/SpeakTouch`.
6. Run `./gradlew assembleDebug` to build the debug version.
7. The apk will be generated in `app/build/outputs/apk/debug`.

## License
[![GNU GPLv3 logo](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.html)
Expand Down

0 comments on commit da5e851

Please sign in to comment.