Skip to content

Commit ac9acb4

Browse files
committed
Updated README.md
1 parent ea4a6df commit ac9acb4

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Natural Language Interface
22

3-
This is the code repository for the Android app developed in the studyproject Sensory augmentation and grasping movements.
3+
This is the code repository for the Android app developed by graduate students at [Osnabrück University](https://www.uni-osnabrueck.de/) during the study projects supervised by [Prof. Dr. Peter König](https://www.ikw.uni-osnabrueck.de/en/research_groups/neurobiopsychology/pk.html):
4+
5+
- Sensory Augmentation and Grasping Movements
6+
- Spatial Navigation supported by AI
47

58
[![Testing APK](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml/badge.svg)](https://github.com/StudyProject-NLI/NLInterface/actions/workflows/debug_build.yml)
69

@@ -9,20 +12,24 @@ This is the code repository for the Android app developed in the studyproject Se
912
```mermaid
1013
gitGraph LR:
1114
commit id: "Current state"
12-
commit id: "Workgroup Release" tag: "v0.0.1"
13-
commit id: "Run example tensorflow model"
15+
commit id: "Workgroup release" tag: "v0.0.1"
16+
commit id: "Run example TensorFlow model"
1417
commit id: "Feedback round with experimental group"
15-
commit id: "Integrate feedback" tag: "v0.0.2"
18+
commit id: "Integrate feedback" tag: "v0.0.2"
1619
commit id: "Christmas break"
1720
commit id: "Object detection via any image input"
1821
commit id: "Polishing"
1922
commit id: "Optivist Presentation" tag: "v0.0.3"
2023
commit id: "Prepare for codebase transfer"
24+
commit id: "Location functionalities"
25+
commit id: "Improved GUI" tag: "v0.0.4"
26+
commit id: "Integrated LLM interface" tag: "v0.0.5"
2127
```
2228

23-
2429
# Building the app locally
30+
2531
Requirements:
32+
2633
- At least Java 17 JDK installed
2734
- Create a `local.properties` file at the root of this repository with the following content
2835

@@ -32,15 +39,15 @@ MAPS_API_KEY=your_google_maps_api_key
3239

3340
You can request your keys via the [Google Maps Platform](https://developers.google.com/maps/documentation/embed/get-api-key).
3441

35-
Then build the application with
42+
Then build the application with
3643

3744
```
3845
./gradlew build -x lint -x lintVitalRelease
3946
```
4047

4148
on MacOS or Linux based operating systems.
4249

43-
The resulting installable application can be found under
50+
The resulting installable application can be found under
4451

4552
`app/build/outputs/apk/debug/app-debug.apk`
4653

@@ -49,11 +56,16 @@ which you can copy and install on your device.
4956
# Documentation
5057

5158
## Running locally
59+
5260
- Install Python
5361
- `pip install -r docs/requirements.txt`
5462

55-
Run the documentation server via
63+
Run the documentation server via
64+
5665
```bash
5766
$ mkdocs serve
5867
```
5968

69+
## Integrations
70+
71+
- [Context-Aware LLM Navigation Interface for Accessibility Apps](https://github.com/RillJ/llm-app-interface)

0 commit comments

Comments
 (0)