From 6868ee1f2f2a1af6788075af62d1903a368d08e8 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Fri, 22 Aug 2014 10:18:45 +0100 Subject: Update installation instructions. --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 785b664..c01b046 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,18 @@ 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: +Typical usage should be limited to that described in the [documentation](http://alaveteli.org/docs/customising/themes/): - * Putting CSS-based customisations in `public/stylesheets/custom.css` - * Creating your own versions of non-functional pages (like "about - us", at `lib/views/help/about.rhtml` -- and/or localised versions at - lib/views/help/about.es.rhtml) +## To install: -To install:: +In the Alaveteli general.yml configuration file change the default mysociety theme repository to your theme repository in the THEME_URLS setting: - ./script/plugin install git://github.com/mysociety/alavetelitheme.git + THEME_URLS: + - 'git://github.com/YOUR_GITHUB_USERNAME/YOUR_THEME_NAME.git' -Look in the lib/ folder of the plugin to see how the overrides happen. +You can then switch the theme the application is using: -Note that the `install.rb` plugin point sets up a symlink to include -local resource files within the Rails `public/` directory. + bundle exec rake themes:install Copyright (c) 2011 mySociety, released under the MIT license -- cgit v1.2.3 From 076121e3603c7c457f320e027322be5f67992e52 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Wed, 24 Sep 2014 08:55:39 +0100 Subject: Code formatting, link to config section of docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c01b046..ebf8b4b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Typical usage should be limited to that described in the [documentation](http:// ## To install: -In the Alaveteli general.yml configuration file change the default mysociety theme repository to your theme repository in the THEME_URLS setting: +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' -- cgit v1.2.3