Permalink
Browse files

Improved README.md.

  • Loading branch information...
1 parent 95d28da commit dee58ac850b421ba70666bb0ee65c281da504c71 @berkerpeksag committed Aug 10, 2012
Showing with 32 additions and 4 deletions.
  1. +32 −4 README.md
View
@@ -2,7 +2,8 @@
[![Travis CI](https://secure.travis-ci.org/berkerpeksag/murl.png)](http://travis-ci.org/berkerpeksag/murl)
-murl is a tiny wrapper for the Python module [urlparse](http://docs.python.org/library/urlparse.html).
+murl is a tiny wrapper for the Python module
+[urlparse](http://docs.python.org/library/urlparse.html).
## Installation
@@ -55,13 +56,40 @@ print url.url
# http://bugzilla.webkit.org/list_bugs.cgi?id=698201
```
-## Development
+## Hacking
-You can run tests by typing `nosetests -v`.
+To setup a local dev environment for hacking:
+
+1. Clone the repo::
+
+```sh
+$ git clone git://github.com/berkerpeksag/murl.git
+$ cd murl
+```
+
+2. Create and activate a new virtual environment:
+
+```sh
+$ virtualenv .
+$ source bin/activate
+```
+
+3. Install required dependencies:
+
+```sh
+$ pip install -r requirements.txt
+```
+
+4. To run the tests, do:
+
+```sh
+$ nosetests -v
+```
## License
-All files that are part of this project are covered by the following license, except where explicitly noted.
+All files that are part of this project are covered by the following
+license, except where explicitly noted.
> This Source Code Form is subject to the terms of the Mozilla Public
> License, v. 2.0. If a copy of the MPL was not distributed with this

0 comments on commit dee58ac

Please sign in to comment.