Skip to content

Commit 7167044

Browse files
authored
Update README.md
1 parent d6ba286 commit 7167044

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

Diff for: android_app_team16/README.md

+33-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
11
# Android Studio Setup
2+
The Android Studio IDE can be downloaded [here](https://developer.android.com/studio?gad_source=1&gclid=CjwKCAjw26KxBhBDEiwAu6KXt9xJpCalnDTE7JICAHzDQWsQN_PKbyNYdl6o0rNav8LPQDlxV7bteRoCXh4QAvD_BwE&gclsrc=aw.ds). Normally, you can either build the app using Java or Kotlin for the back-end, and using XML for the front-end.
23

4+
## Project Structure
5+
The essential folders and files are:
36

7+
.
8+
├── app
9+
│ ├── src # The main directory for the source files.
10+
│ │ ├── main # Contains the primary code and resources.
11+
│ │ │ ├── AndroidManifest.xml # Configures the app's name, icon, and permissions.
12+
│ │ │ ├── res # Resources folder containing layouts and other UI elements.
13+
│ │ │ │ ├── layout # Holds XML front-end files defining the user interface.
14+
│ │ │ │ │ ├── biner_base.xml # XML layouts for HSV segmentation activity.
15+
│ │ │ │ │ ├── activity_reference_input.xml # XML layouts for taking input from the user.
16+
│ │ │ │ │ ├── camera_view.xml # XML layouts for the main activity.
17+
│ │ │ ├── java/.../na568Teamproject_MohammedAlanUsmanBahru/ # Java back-end source code directory.
18+
│ │ │ │ │ │ ├── SeekBarHsvSeg.java # Manages the user interface for a feature involving an HSV color model.
19+
│ │ │ │ │ │ ├── ReferenceInput.java # Handles user input for reference settings.
20+
│ │ │ │ │ │ ├── MainActivity.java # The main activity managing the core functionality.
21+
│ │ │ │ │ │ ├── NoiseEstimator.java # Manages noise estimation for sensors and updating noise parameters.
22+
│ │ │ │ │ │ ├── KalmanFilter.java # Implements a Kalman filter for estimating and updating the state.
23+
└── ...
424

525
## Dependencies
6-
For running the app via Android Studio, This application requires the following libraries:
7-
* OpenCV 4.1.0 (can be downloaded here [download](https://sourceforge.net/projects/opencvlibrary/files/4.1.0/opencv-4.1.0-android-sdk.zip/download))
26+
For running the app via Android Studio, this application uses the following libraries:
27+
* OpenCV 4.1.0 (can be explored [here](https://opencv.org/releases/page/4/) or directly downloaded [here](https://sourceforge.net/projects/opencvlibrary/files/4.1.0/opencv-4.1.0-android-sdk.zip/download))
28+
29+
## Devoloping and Building
30+
1) Download or clone the repository.
31+
2) Open this 'android_app_team16' project in your Android Studio IDE. Check and click "Trust Project".
32+
3) In the Menu Bar try: *Build* → *Rebuild Project*.
33+
4) If the build is successful:
34+
- In your Android device, turn on the USB debugging: *Settings* → *About phone* → tap *Build number* x 7 times → allow for being developer → go back to *Settings* → *Systems* → *Developer options* → scroll down → turn on *USB debugging*.
35+
- Connect your Android device to your computer via USB cable.
36+
- In the Android app press *Run* (or pressing control+R) button at the top of the window.
37+
5) If the build is not successful:
38+
-

0 commit comments

Comments
 (0)