heckyel/mediagoblin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of gitorious.org:mediagoblin/mediagoblin

Browse Source
This commit is contained in:
Christopher Allan Webber 2011-04-19 19:05:58 -05:00
commit 9ec5910861
1 changed files with 53 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
docs/hackinghowto.rst
View File

@ -19,24 +19,37 @@ Additionally, we have information on how to get involved, who to talk
to, what needs to be worked on, and other things besides!
How to set up an environment for hacking
========================================
How to set up and maintain an environment for hacking
=====================================================
If running Debian GNU/Linux or a Debian-derived distro such as Mint or
Ubuntu, running the following should install necessary dependencies:
Getting requirements
--------------------
First, you need to have the following installed before you can build
an environment for hacking on GNU MediaGoblin:
* Python 2.6 or 2.7 - http://www.python.org/
You'll need Python as well as the dev files for building modules.
* python-lxml - http://lxml.de/
* git - http://git-scm.com/
* MongoDB - http://www.mongodb.org/
If you're running Debian GNU/Linux or a Debian-derived distribution
such as Mint or Ubuntu, running the following should install these
requirements::
sudo apt-get install mongodb git-core python python-dev python-lxml
Note: The following instructions describe a development environment
that uses `zc.buildout <http://www.buildout.org/>`_ because it
involves less steps to get things running and less knowledge of python
packaging. However, if you prefer to use
`virtualenv <http://pypi.python.org/pypi/virtualenv>`_,
that should work just fine.
Follow these steps:
Running bootstrap and buildout
------------------------------
1. clone the repository::
After installing the requirements, follow these steps:
1. Clone the repository::
git clone http://git.gitorious.org/mediagoblin/mediagoblin.git
@ -45,17 +58,31 @@ Follow these steps:
cd mediagoblin
python bootstrap.py && ./bin/buildout
Now whenever you want to update mediagoblin's dependencies, just run::
That's it! Using this method, buildout should create a ``user_dev``
directory, in which certain things will be stored (media, beaker
session stuff, etc). You can change this, but for development
purposes this default should be fine.
.. Note::
We used `zc.buildout <http://www.buildout.org/>`_ because it
involves fewer steps to get things running and less knowledge of
Python packaging. However, if you prefer to use `virtualenv
<http://pypi.python.org/pypi/virtualenv>`_, that should work just
fine.
Updating dependencies
---------------------
While hacking on GNU MediaGoblin over time, you'll eventually have to
update the dependencies. To do that, run::
./bin/buildout
Using this method, buildout should create a user_dev directory, in
which certain things will be stored (media, beaker session stuff,
etc). You can change this, but for development purposes this default
should be fine.
Running the server
==================