Renamed and modified the README

README.markdown → README.md

@@ -2,52 +2,56 @@
 A web application to monitor and analyze the performance of your code
 
 # Requirements
-You will need Python 2.6+ and Django 1.1+. If you need SVN integration, pysvn is also requiered.
+You will need Python 2.6+ and Django 1.1+.
+
 In Ubuntu, they can be installed with
     sudo apt-get install python-django
-and
+If you need SVN integration, pysvn is also requiered:
     sudo apt-get install python-svn
 
 # Installation
-Download a release and unpack it
+* Download a release and unpack it
     wget http://github.com/tobami/codespeed/tarball/0.5
 
-For simplicity, you can use the default sqlite configuration, which will save the data to a database named speedcenter/data.db
+* For simplicity, you can use the default sqlite configuration, which will save the data to a database named `speedcenter/data.db`.
 
 Create the DB by changing to the `speedcenter/` directory and typing:
     python manage.py syncdb
 Create an admin user in the process.
 
-For testing purposes, you can now start the development server:
+* For testing purposes, you can now start the development server:
     python manage.py runserver 8000
 
 The codespeed installation can now be accessed by navigating to `http://localhost:8000/`.
 
-Note: for production you should configure a real server like Apache, lighttpd, etc... (refer to the Django docs: `http://docs.djangoproject.com/en/dev/howto/deployment/`). You should also modify `speedcenter/settings.py` and set `DEBUG = False`.
+Note: for production, you should configure a real server like Apache, lighttpd, etc... (refer to the Django docs: `http://docs.djangoproject.com/en/dev/howto/deployment/`). You should also modify `speedcenter/settings.py` and set `DEBUG = False`.
 
 # Codespeed configuration
 Before you can start saving (and displaying) data, you need to first create an environment and define a default project.
+
 * Go to `http://localhost:8000/admin/codespeed/environment/`
 and create an environment.
 * Go to `http://localhost:8000/admin/codespeed/project/`
-and create a project. Check the field "Track changes" and, in case you want version control integration, configure the relevant fields.
+and create a project.
+Check the field "Track changes" and, in case you want version control integration, configure the relevant fields.
 
 # Saving data
-Data is saved POSTing to `http://localhost:8000/result/add/`
+Data is saved POSTing to `http://localhost:8000/result/add/`.
+
 You can use the script `tools/save_single_result.py` as a guide.
 
 # Further customization
 
 ## Looks
 The logo and title can be changed for every speedcenter.
-In `templates/base.html`
-subtitute "My Speed Center" by any name.
-The logo is defined in `<img src="/media/images/logo.png" height="48" alt="logo"/>`
+
+* In `templates/base.html`, subtitute "My Speed Center" by any name.
+* The logo is defined in `<img src="/media/images/logo.png" height="48" alt="logo"/>`
 Either substitute the file `speedcenter/media/images/logo.png" by your own logo, of change the tag to whatever you see fit. The layout will stay exactly the same for any image with a height of 48px (any width will do).
 
 ## Defaults
 The file `speedcenter/codespeed/settings.py` can contain customizations of several parameters (the file includes comments with full examples).
 
-* defaultexecutable: in the overview, a random executable is chosen as default. It that doesn't suit you, you can specify here which one should be selected. You need to specify itss id (since the name alone is not unique).
+* defaultexecutable: in the overview, a random executable is chosen as default. It that doesn't suite you, you can specify here which one should be selected. You need to specify itss id (since the name alone is not unique).
 * baselinelist: This option specifies which results (combination of an executable and a revision/tag) will be available as an option for comparing in the overview and as a baseline for the timeline view. If nothing is specified, all revisions (together with their corresponding executables) that contain a tag will be included.
 * defaultbaseline: Defines which baseline option will be chosen as default in the overview, and which one will be available as a basline in the timeline vies.