Skip to content

Commit 03a969e

Browse files
committed
Update README.md
1 parent d817bcc commit 03a969e

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55

66
This is being done as a hobby, and for experimenting, so probably there might be some flaws; As an example, the vendor ID of Arduino is hardcoded to only work with Arduino devices, but this is my use case and please feel free to change it to match your needs.
77

8+
# Install
9+
The app is available for free on Google Play Store (Arduino USB Terminal).
10+
Otherwise, you can clone the project and run it locally.
11+
Please read the **Sentry Reports** part on this page before running the project to avoid build failures.
12+
813
## Terminal
914
A Simple terminal page which does what it is supposed to do interacting with an Arduino manually through the USB cable.
1015

@@ -14,9 +19,20 @@
1419
## Tests
1520
Under Construction
1621

22+
## Sentry Reports
23+
The project uses Sentry for the crash reports, if this is not needed, you can remove the following line in `AndroidManifest.xml`:
24+
`<meta-data android:name="io.sentry.dsn" android:value="@string/sentry_dsn" />`
25+
But if it is needed, you need to [create a Sentry dsn value](https://docs.sentry.io/platforms/android/) to put under the following path:
26+
`app/src/main/res/values/api_keys.xml`
27+
The file contents might look like similar to this:
28+
`<?xml version="1.0" encoding="utf-8"?>
29+
<resources>
30+
<string name="sentry_dsn" translatable="false">YOUR_SENTRY_SPECIFIC_VALUE</string>
31+
</resources>`
32+
33+
1734
### Knows Issues
18-
_On Android 5.1.1, the Arduino serial output cannot be shown. (It is said that an Android internal bug is the issue!)_ This was hopefully solved using LiveData
19-
The Arduino output characters might be shown a bit weird in the app while skipping some characters when the message is too long. This will be fixed as I figure out the reason! Any suggestions will be appreciated. :)
35+
_Still unknown! :)
2036

2137
Suggestions and PRs are welcome! :)
2238

0 commit comments

Comments
 (0)