Home - GeoRemindMe/GeoRemindMe_Web GitHub Wiki
GeoRemindMe Wiki-Guide: Start contributing
Step 0- Install Git
If it's your first time using Git, maybe you should read how to set up your repository.
Recommended: Add colored git branch name to your shell prompt
Step 1- Request to join
To start contributing you need to create an account on GitHub and then go to the GeoRemindMe project on GitHub and create a fork of the Web or the Android App. You can read more about the workflow on GitHub here, or how to create a patch.
Step 2- Setup a local enviroment
This document attemp to be an introduction for anyone who wants to start coding at the project and who has never programmmed with Google App Engine.
The project is been developed on Python+Django running on App Engine.
Step 3- Join us on Teambox
Step 4- Do whatever you want
''Please before start working, check if your team/s has/have instructions to guide you how to work. This information can be found on the links in "Step 2- Where can I help?".''.
First run sphinx-build to know if you already have Sphinx installed and see which version.
NOTE: you also need to have Django and Google App Engine installed
To create documentation using: easy_install -U Sphinx
Install using APTITUDE
First check Sphinx version using: sudo aptitude show python-sphinx
If version >= 1.0.7 then run: sudo aptitude install python-sphinx
Run this (Note: notice that there are some variables)
tar xvfz Sphinx-1.0.7.tar.gz
python setup.py build
sudo python setup.py install
sudo aptitude install python-docutils
sudo aptitude install python-jinja2
sudo aptitude install python-yaml
pwd #This command shows your local path, required for the next step
sudo ln -s [LOCAL_PATH_TO]/sphinx-build.py /usr/bin/sphinx-build
Then you can go to your "doc/" directory and run "make html"
Then go to the "Task List" on Teambox and see what you wanna do.
Step 5- Notify us your progress :D
Please let us know on any progress you made to be able to follow what are you doing.
Any other question?, feel free to ask here.