Skip to content

Commit a977772

Browse files
committed
basic install instructions
1 parent dbbbec1 commit a977772

8 files changed

Lines changed: 56 additions & 2 deletions

File tree

139 KB
Loading
123 KB
Loading

docs/images/install/repo.jpg

166 KB
Loading

docs/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# Overview
22

3-
Welcome to the documentation of NLInterface Project!
3+
Welcome to the documentation of NLInterface Project!
4+
5+
## Are you a tester?
6+
Checkout the [installation guide](installation/install_from_actions.md) to get the current version running on your Android device.
7+
8+
## Are you a developer?
9+
Use our [Android Studio Setup Guide](installation/android_studio_setup.md) and [architecture](architecture/overview.md) to contribute new features and fix bugs.
10+
11+
## Are you our supervising professor?
12+
We are not done yet, please look somewhere else.
13+
14+
![](https://i.imgflip.com/wfenk.jpg?a472104)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
t.b.d.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Install Debug Build from GitHub Actions
2+
3+
You can always install latest version of the main branch directly from GitHub Actions.
4+
5+
!!! warning
6+
The latest build on the main branch is considered bleeding edge and will most **certainly contain bugs**!
7+
Only use it when you are testing and are fine with the app breaking.
8+
9+
For more stabilized versions, use the one of the [official releases](install_from_release.md).
10+
11+
## Prerequisites
12+
13+
- An Android device in [developer mode](https://developer.android.com/studio/debug/dev-options)
14+
- You are logged into your GitHub account on your device
15+
16+
Open up the repo on your device by following the link
17+
18+
[https://github.com/StudyProject-NLI/NLInterface](https://github.com/StudyProject-NLI/NLInterface)
19+
20+
and navigate to the **Actions** tab by pressing the three dots button on the right.
21+
22+
![](../images/install/repo.jpg)
23+
24+
Select a successfull workflow run of **Testing APK**
25+
26+
![](../images/install/actions_screen.jpg)
27+
28+
Download the app-debug-build artifact.
29+
30+
![](../images/install/artifact_build.jpg)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Install from GitHub Release
2+
3+
t.b.d. when v0.0.1 is released.

mkdocs.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,13 @@ markdown_extensions:
5757

5858
plugins:
5959
- offline
60-
- search
60+
- search
61+
62+
nav:
63+
- Overview: index.md
64+
- Installation:
65+
- installation/install_from_actions.md
66+
- installation/install_from_release.md
67+
- Development:
68+
- installation/android_studio_setup.md
69+
- architecture/overview.md

0 commit comments

Comments
 (0)