Skip to content

Commit cbf890e

Browse files
authored
Update README.md
1 parent 043a792 commit cbf890e

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
1-
# controllerformote-android
2-
Controller for Mote® Android Application
1+
# Controller for Mote®
2+
3+
Controller for Mote® is a simple open source application which lets you control your Pimoroni® Mote from your Android device.
4+
5+
It requires Android v4.1 (Jelly Bean) or higher, and also requires that you install and run the required Mote API code on the device your Mote is plugged in to. The required Mote API code is available separately and can be found on GitHub at **[EarthstormSoftware/controllerformote-api](https://github.com/EarthstormSoftware/controllerformote-api)** along with full instructions.
6+
7+
You can find more information about Mote on the **[Pimoroni website](https://shop.pimoroni.com/products/mote)**.
8+
9+
### Raising Issues
10+
Issues can be raised via the **[GitHub Issue tracker](https://github.com/EarthstormSoftware/controllerformote-android/issues)**
11+
12+
### Contributing
13+
Before raising a pull request, it's recommended to raise an issue to enable discussion of the suggested change before spending time coding it. If there is no existing issue, please raise a new one. This is to reduce frustration at spending precious time crafting a change only for it to be rejected.
14+
15+
### Building the Code.
16+
The repository should be able to be pulled directly into Android Studio, or onto a correctly configured standalone build system, and then built. Note that the default configuration is such that an example applicationId is used, and that the 'release' build task will **not** sign the apk.
17+
18+
#### Trademarks
19+
Pimoroni and Mote are trademarks of Pimoroni Ltd

0 commit comments

Comments
 (0)