Skip to content

Commit 1cf3ac7

Browse files
author
mhaeming
committed
add README + set version 0.0.1
1 parent 72cd497 commit 1cf3ac7

2 files changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Natural Language Interface
2+
3+
This is the code repository for the Android app developed in the studyproject Sensory augmentation and grasping movements.
4+
5+
![Debug APK Builds](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
6+
7+
# Building the app locally
8+
Requirements:
9+
- At least Java 8 JDK installed
10+
- Create a `local.properties` file at the root of this repository with the following content
11+
12+
```bash
13+
MAPS_API_KEY=your_google_maps_api_key
14+
```
15+
16+
You can request your keys via the [Google Maps Platform](https://developers.google.com/maps/documentation/embed/get-api-key).
17+
18+
Then build the application with
19+
20+
```
21+
./gradlew build -x lint -x lintVitalRelease
22+
```
23+
24+
on MacOS or Linux based operating systems.
25+
26+
The resulting installable application can be found under
27+
28+
`app/build/outputs/apk/debug/app-debug.apk`
29+
30+
which you can copy and install on your device.
31+
32+
33+
# Local Development Setup
34+
35+
We are using [Android Studio](https://developer.android.com/studio/) for development.
36+
37+
38+
# Architecture Overview
39+
40+
t.b.d

app/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ android {
1515
minSdk 24
1616
targetSdk 33
1717
versionCode 1
18-
versionName "1.0"
18+
versionName '0.0.1'
1919

2020
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
2121
}

0 commit comments

Comments
 (0)