Skip to content

Commit e6e1986

Browse files
committed
Clarify installation
1 parent 9c44408 commit e6e1986

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,13 @@ Known to be used by [PyPy](http://speed.pypy.org), [Twisted](http://speed.twiste
77

88
For an overview of some application concepts see the [wiki page](https://github.com/tobami/codespeed/wiki/Overview)
99

10-
# Requirements
11-
12-
You will need Python 2.6+ and Django 1.4+ with South and isodate
13-
14-
To install all needed dependencies using pip:
10+
# Installation
1511

16-
pip install -r requirements.txt
12+
You will need Python 2.6 or 2.7.
1713

1814
To install dependencies and the codespeed Django app:
1915

20-
python setup.py install
16+
pip install codespeed
2117

2218
If you want version control integration, there are additional requirements:
2319

@@ -30,8 +26,6 @@ If you want version control integration, there are additional requirements:
3026
Codespeed will try to clone the repo, which depending on the size of the project
3127
can take a long time. Please be patient.
3228

33-
# Installation
34-
3529
* Download the last stable release from
3630
[github.com/tobami/codespeed/tags](https://github.com/tobami/codespeed/tags), unpack it and install it with `python setup.py install`.
3731
* To get started, you can use the `sample_project` directory as a starting point for your Django project, which can be normally configured by editing `sample_project/settings.py`.
@@ -42,7 +36,7 @@ can take a long time. Please be patient.
4236
python manage.py syncdb
4337

4438
* Create an admin user in the process.
45-
* Migrate to the new DB Schema:
39+
* Execute DB migrations:
4640

4741
python manage.py migrate
4842

@@ -54,6 +48,7 @@ The codespeed installation can now be accessed by navigating to `http://localhos
5448

5549
**Note**: for production, you should configure a real server like Apache or nginx (refer to the [Django docs](http://docs.djangoproject.com/en/dev/howto/deployment/)). You should also
5650
modify `sample_project/settings.py` and set `DEBUG = False`.
51+
[`sample_project/README.md`](https://github.com/tobami/codespeed/tree/master/sample_project/README.md) also describes some production settings.
5752

5853
# Codespeed configuration
5954

0 commit comments

Comments
 (0)