Google Code-in

Kiwix is a Wikipedia offline reader which runs on Windows, GNU/Linux, OSX, iOS and Android. The Google Code-in tasks are related to the Android app, they require knowledge of the Java programming language.

On a boat, in the middle of nowhere or in Jail, Kiwix gives you access to the whole human knowledge, offline, on your mobile device!

For most tasks simply downloading and installing Android Studio is sufficient to start developing. You can then use either a real or virtual device to test your changes.

If you need help either post in the GCI task or ask in #kiwix on IRC for help.

Once you are ready to begin:

1. Fork our GitHub repository https://github.com/kiwix/kiwix
2. Clone your fork to your machine
3. Use Android Studio to import the android directory of the project
4. Make your changes and test them
5. Commit and push your changes to your fork
6. Create a pull request so we can review your changes https://github.com/kiwix/kiwix/pulls
7. Submit the task on the GCI site and wait for your changes to be reviewed
8. If everything is good then we will merge your changes and complete the task otherwise we will provide you with feedback so that you can make changes and resubmit

More advanced tasks may first require you to prepare our full build environment. The easiest way to do this is with a Virtual Machine:

1. Download the KiwixDev virtual machine (KiwixDev torrent)
2. Import it on your preferred virtual machine (for example VirtualBox
3. Launch the virtual machine
4. Follow the android compilation instructions here: https://github.com/kiwix/kiwix/blob/master/android/README