Skip to content

Commit

Permalink
add installation instructions to README.md. add url in setup.py.
Browse files Browse the repository at this point in the history
  • Loading branch information
Brian Rue committed Jun 13, 2012
1 parent 014a72e commit a14eece
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
17 changes: 16 additions & 1 deletion README.md
Expand Up @@ -16,7 +16,22 @@ django_ratchet requires:

Installation
------------
abcdefg
Get the django_ratchet code by cloning the git repo (or [download the zip](https://github.com/brianr/django_ratchet/zipball/master) and unzip it somewhere):

git clone https://github.com/brianr/django_ratchet.git

Once you download it, install like this:

cd django_ratchet
python setup.py install

If you'd like to be able to update at any time by pulling down the latest change from git without running `python setup.py install` again, you can symlink the inner module into your `site-packages`:

ln -s /absolute/path/to/django_ratchet/django_ratchet /absolute/path/to/site-packages

To make sure it works, run:

python -c 'import django_ratchet; print "It works!"'


Configuration
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -16,7 +16,7 @@
long_description=README,
author='brianr',
author_email='brian@ratchet.io',
url='',
url='http://github.com/brianr/django_ratchet',
classifiers=[
"Development Status :: 1 - Planning",
"Intended Audience :: Developers",
Expand Down

0 comments on commit a14eece

Please sign in to comment.