Tell us your story
Tell us your story
How has offline Wikipedia affected you? The Wikimedia Foundation (the non-profit that supports Wikipedia) is looking for personal, diverse and inspiring stories about how offline Wikipedia affects the world. If you have a personal story that you would like to share, please contact: stories@kiwix.org. Thank you!

Difference between revisions of "Google Code-in"

From Kiwix
Jump to: navigation, search
(Improved insturctions)
m
Line 5: Line 5:
 
Once you are ready to begin:
 
Once you are ready to begin:
 
# Fork our GitHub repository https://github.com/kiwix/kiwix
 
# Fork our GitHub repository https://github.com/kiwix/kiwix
# Clone your fork to your machine.
+
# Clone your fork to your machine
# Use android studio to import the android directory of the project.
+
# Use android studio to import the android directory of the project
 
# Make your changes and test them.
 
# Make your changes and test them.
 
# Commit and push your changes to your fork
 
# Commit and push your changes to your fork
Line 12: Line 12:
 
# Submit the task on the GCI site and wait for your changes to be reviewed
 
# Submit the task on the GCI site and wait for your changes to be reviewed
 
# 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
 
# 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.
+
More advanced tasks may first require you to prepare our full build environment. The easiest way to do this is with a Virtual Machine:
 
# Download the [http://download.kiwix.org/dev/KiwixDev.ova KiwixDev virtual machine] ([http://download.kiwix.org/dev/KiwixDev.ova.torrent KiwixDev torrent])
 
# Download the [http://download.kiwix.org/dev/KiwixDev.ova KiwixDev virtual machine] ([http://download.kiwix.org/dev/KiwixDev.ova.torrent KiwixDev torrent])
 
# Import it on your preferred virtual machine (for example [https://www.virtualbox.org/ VirtualBox]
 
# Import it on your preferred virtual machine (for example [https://www.virtualbox.org/ VirtualBox]
 
# Launch the virtual machine
 
# Launch the virtual machine
 
# Follow the android compilation instructions here: https://github.com/kiwix/kiwix/blob/master/android/README
 
# Follow the android compilation instructions here: https://github.com/kiwix/kiwix/blob/master/android/README

Revision as of 10:14, 23 November 2016

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!

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.

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.

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