You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,10 +36,10 @@ can take a long time. Please be patient.
36
36
37
37
* Download the last stable release from
38
38
[http://github.com/tobami/codespeed/downloads](http://github.com/tobami/codespeed/downloads), unpack it and install it with `python setup.py install`.
39
-
* To get started, you can use the `example` directory as a starting point for your Django project, which can be normally configured by editing `example/settings.py`.
39
+
* 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`.
40
40
* For simplicity, you can use the default sqlite configuration, which will save
41
-
the data to a database named `example/data.db`
42
-
* Create the DB by changing to the `example/` directory and running:
41
+
the data to a database named `sample_project/data.db`
42
+
* Create the DB by changing to the `sample_project/` directory and running:
43
43
44
44
python manage.py syncdb
45
45
@@ -55,7 +55,7 @@ can take a long time. Please be patient.
55
55
The codespeed installation can now be accessed by navigating to `http://localhost:8000/`.
56
56
57
57
**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
58
-
modify `example/settings.py` and set `DEBUG = False`.
58
+
modify `sample_project/settings.py` and set `DEBUG = False`.
59
59
60
60
# Codespeed configuration
61
61
@@ -73,7 +73,7 @@ integration, configure the relevant fields.
73
73
**Note**: Only executables associated to projects with a checked "track changes"
74
74
field will be shown in the Changes and Timeline views.
75
75
76
-
**Note**: Git and Mercurial need to locally clone the repository. That means that your `example/repos` directory will need to be owned by the server. In the case of a typical Apache installation, you'll need to type `sudo chown www-data:www-data example/repos`
76
+
**Note**: Git and Mercurial need to locally clone the repository. That means that your `sample_project/repos` directory will need to be owned by the server. In the case of a typical Apache installation, you'll need to type `sudo chown www-data:www-data sample_project/repos`
77
77
78
78
# Saving data
79
79
@@ -97,7 +97,7 @@ section).
97
97
## Custom Settings
98
98
99
99
You may override any of the default settings by creating the file
100
-
`example/override/settings.py`. It is strongly recommended that you only override the
100
+
`sample_project/override/settings.py`. It is strongly recommended that you only override the
101
101
settings you need by importing the default settings and replacing only the
102
102
values needed for your customizations:
103
103
@@ -108,7 +108,7 @@ values needed for your customizations:
108
108
### Site-wide Changes
109
109
110
110
All pages inherit from the `site_base.html` template, which
111
-
extends `base.html`. To change every page on the site simply edit (`example/templates/site_base.html`) which extends `base.html` and override
111
+
extends `base.html`. To change every page on the site simply edit (`sample_project/templates/site_base.html`) which extends `base.html` and override
112
112
the appropriate block:
113
113
114
114
* Custom title: you may replace the default "My Speed Center" for the title
@@ -118,7 +118,7 @@ the appropriate block:
118
118
My Project's Speed Center
119
119
{% endblock %}
120
120
121
-
* Custom logo: Place your logo in `example/override/media/img` and add a block like
121
+
* Custom logo: Place your logo in `sample_project/override/media/img` and add a block like
122
122
this:
123
123
124
124
{% block logo %}
@@ -128,7 +128,7 @@ the appropriate block:
128
128
n.b. the layout will stay exactly the same for any image with a height of
129
129
48px (any width will do)
130
130
131
-
* Custom JavaScript or CSS: add your files to the `example/override/media` directory
131
+
* Custom JavaScript or CSS: add your files to the `sample_project/override/media` directory
132
132
and extend the `extra_head` template block:
133
133
134
134
{% block extra_head %}
@@ -138,11 +138,11 @@ the appropriate block:
138
138
139
139
### Specific Pages
140
140
141
-
Since `example/override/templates` is the first entry in `settings.TEMPLATE_DIRS` you
141
+
Since `sample_project/override/templates` is the first entry in `settings.TEMPLATE_DIRS` you
142
142
may override any template on the site simply by creating a new one with the
143
143
same name.
144
144
145
-
* About page: create `example/override/templates/about.html`:
145
+
* About page: create `sample_project/override/templates/about.html`:
146
146
147
147
{% extends "site_base.html" %}
148
148
{% block title %}{{ block.super }}: About this project{% endblock %}
@@ -161,7 +161,7 @@ same name.
161
161
of projects being tracked as an executable as well.
162
162
163
163
## Defaults
164
-
The file `example/settings.py` can contain customizations of
164
+
The file `sample_project/settings.py` can contain customizations of
165
165
several parameters (the file includes comments with full examples).
0 commit comments