extern/Unexpected-Keyboard
1
0
Fork 1
mirror of https://github.com/Julow/Unexpected-Keyboard.git synced 2024-11-25 00:33:24 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
d4eef00a8a
Unexpected-Keyboard/CONTRIBUTING.md
Jules Aguillon d4eef00a8a Add a CONTRIBUTING guide
2022-01-15 18:55:05 +01:00

1.0 KiB
Raw Blame History

Contributing

Thanks for contributing :)

Building the app

The application doesn't use Gradle and it might be hard to use some features of Android Studio.

Fortunately, there's not many dependencies:

  • OpenJDK 8
  • Android SDK: build tools 30.0.3, platform 30
  • Make sure to have the $ANDROID_HOME environment variable set.

For Nix users, there's a shell.nix for setting-up the right environment.

Building the debug apk:

make

If the build succeed, the debug apk is located in _build/juloo.keyboard2.debug.apk.

Debugging on your phone

You need to have USB debugging enabled on your phone, see Android's doc.

It is also possible to enable ADB over network in the settings and connect with adb connect <ip of the phone>. Make sure to be connected to a local network that you trust.

Install the application with:

make installd

The debug version of the application won't be removed, both versions will stay installed at the same time.