Skip to content
This repository was archived by the owner on Oct 28, 2019. It is now read-only.

Commit 2e325a1

Browse files
committed
Update readme
1 parent efc951d commit 2e325a1

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed

README.md

+50-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Snippt is an easy to use paste site inspired by [sprunge](http://sprunge.us) and
66

77
There are two ways to use snippt:
88

9-
*Web UI
10-
*Command-line interface
9+
* Web UI
10+
* Command-line interface
1111

12-
To use the web UI simply navigate to http://s.drk.sc (or http://snippt.herokuapp.com if that doesn't resolve).
12+
To use the web UI simply navigate to http://s.drk.sc (or http://s.drk.sc if that doesn't resolve).
1313

1414
To use the command line tool, use `<command> | curl -F 'paste=<-' http://s.drk.sc`.
1515

@@ -20,3 +20,50 @@ You can also add that command to your bash/zsh alias file so that you can use it
2020
Simply add `alias snippt="curl -F 'paste=<-' http://s.drk.sc"`. This will allow you to use `<command> | snippt`.
2121

2222
See [here](http://s.drk.sc/man/) for more information.
23+
24+
### Setting up the development environment
25+
26+
Firstly, you will need to clone the source code. This can be done via:
27+
28+
```bash
29+
$ git clone https://github.com/kylef/snippt
30+
$ cd snippt
31+
```
32+
33+
While there are many ways to set up one’s development environment, following is
34+
a method that uses virtualenv. If you don’t have virtualenv installed, you can
35+
install it via:
36+
37+
```bash
38+
$ pip install virtualenv
39+
```
40+
41+
Virtual environments allow you to work on Python projects which are isolated
42+
from one another so you can use different packages (and package versions) with
43+
different projects.
44+
45+
To create and activate a virtual environment, use the following syntax:
46+
47+
```
48+
$ virtualenv venv
49+
$ source venv/bin/activate
50+
```
51+
52+
To install the development dependencies:
53+
54+
```
55+
$ pip install -r requirements.txt
56+
```
57+
58+
Now, you can setup your local database:
59+
60+
```
61+
$ python manage.py syncdb
62+
```
63+
64+
And then run the development server with the following:
65+
66+
```
67+
$ python manage.py runserver
68+
```
69+

requirements.txt

-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,5 @@ Pygments==1.5
44
South==0.7.3
55
docutils==0.8.1
66
gunicorn==0.13.4
7-
httplib2==0.7.2
87
psycopg2==2.4.4
98
django-browserid==0.5

0 commit comments

Comments
 (0)