Skip to content

Commit 69f49ce

Browse files
committed
docs: barcode setting + setup guide
1 parent f5d631c commit 69f49ce

3 files changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,10 @@ This is the code repository for the Android app developed in the studyproject Se
2020
commit id: "Prepare for codebase transfer"
2121
```
2222

23-
# Documentation
24-
25-
## Running locally
26-
- Install Python
27-
- `pip install -r docs/requirements.txt`
28-
29-
Run the documentation server via
30-
```bash
31-
$ mkdocs serve
32-
```
33-
3423

3524
# Building the app locally
3625
Requirements:
37-
- At least Java 8 JDK installed
26+
- At least Java 17 JDK installed
3827
- Create a `local.properties` file at the root of this repository with the following content
3928

4029
```bash
@@ -56,3 +45,15 @@ The resulting installable application can be found under
5645
`app/build/outputs/apk/debug/app-debug.apk`
5746

5847
which you can copy and install on your device.
48+
49+
# Documentation
50+
51+
## Running locally
52+
- Install Python
53+
- `pip install -r docs/requirements.txt`
54+
55+
Run the documentation server via
56+
```bash
57+
$ mkdocs serve
58+
```
59+

docs/architecture/activities/SettingsActivity.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ default theme corresponds to the phone’s system settings. The chosen theme is
77
activated by navigating back to the Main Activity. The button is always labeled with the
88
currently active setting so as not to have too much visual input.
99

10+
- *BARCODE SERVICE SETTINGS*: Toggles the Barcode Scanning Service "on" or "off". Changes will
11+
take effect when you change back into the Main Activity.
12+
1013
## Voice Commands
1114
- "GO TO [DESIRED ACTIVITY NAME]": Navigates to the desired activity.
1215
- "CHANGE THEME [THEME CHOICE]: Changes the theme to the theme choice.
Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
t.b.d.
1+
## Google Maps API Key
2+
After cloning the repository, make sure to add a `local.properties` file to your project which contains the `MAPS_API_KEY` environment variable. You can get a key from the [Google Maps Platform](https://developers.google.com/maps/documentation/embed/get-api-key).
3+
4+
!!! info
5+
If you don't plan to use any navigation or location search feature, just set it to an empty or arbitrary string.

0 commit comments

Comments
 (0)