diff --git a/README.md b/README.md index 914ff2b..e8822c7 100755 --- a/README.md +++ b/README.md @@ -5,13 +5,12 @@ AskNepal Initiative is an open platform which can be used by everyone to ask dat For Local Development =============== -Alaveteli Theme -============== +## Alaveteli Theme -This is a "hello world" type theme package for Alaveteli. -The intention is to support simple overlaying of templates and -resources without the need to touch the core Alaveteli software. +This is a `hello world` type theme package for Alaveteli. + +The intention is to support simple overlaying of templates and resources without the need to touch the core Alaveteli software. Typical usage should be limited to that described in the [documentation](http://alaveteli.org/docs/customising/themes/): @@ -20,8 +19,9 @@ Typical usage should be limited to that described in the [documentation](http:// In the Alaveteli `general.yml` configuration file change the default mysociety theme repository to your theme repository in the [`THEME_URLS`](http://alaveteli.org/docs/customising/config/#theme_urls) setting: - THEME_URLS: - - 'git://github.com/YOUR_GITHUB_USERNAME/YOUR_THEME_NAME.git' +THEME_URLS: + + git://github.com/YOUR_GITHUB_USERNAME/YOUR_THEME_NAME.git You can then switch the theme the application is using: @@ -31,7 +31,7 @@ You can then switch the theme the application is using: To run tests, in the Alaveteli Rails.root (with this theme installed): - bundle exec rspec lib/themes/alavetelitheme/spec + bundle exec rspec lib/themes/alavetelitheme/spec Copyright (c) 2011 mySociety, released under the MIT license