diff options
Diffstat (limited to 'doc/THEMES.md')
| -rw-r--r-- | doc/THEMES.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/THEMES.md b/doc/THEMES.md index 50335c082..6c22764fc 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -36,13 +36,17 @@ places: This document is about what you can do in a theme. -To get started, install the sample theme by running +By default, the sample theme ("alavetelitheme") has already been +installed. See the setting `THEME_URLS` in `general.yml` for an +explanation. - ./script/plugin install git://github.com/sebbacon/alavetelitheme.git +You can also install the sample theme by hand, by running: + + ./script/plugin install git://github.com/mysociety/alavetelitheme.git -This downloads and installs the theme in -`vendor/plugins/alavetelitheme` and contains examples for nearly -everything you might want to customise. +The sample theme contains examples for nearly everything you might +want to customise. You should probably make a copy, rename it, and +use that as the basis for your own theme. # Make sure your theme is as lightweight as possible @@ -81,7 +85,7 @@ instead of the core "about us" file. Rails expects all its stylesheets to live at `<railshome>/public`, which presents a problem for plugins. Here's how we solve it: the stylesheet and associated resources for your theme live (by -convention) in at `alavetelitheme/public/`. This is symlinked from +convention) in `alavetelitheme/public/`. This is symlinked from the main Rails app -- see `alavetelitheme/install.rb` to see how this happens. @@ -108,7 +112,7 @@ locale you support. # Customising the request states As mentioned above, if you can possibly live with the -[default Alaveteli request statuses](https://github.com/sebbacon/alaveteli/wiki/Alaveteli's-request-statuses), +[default Alaveteli request statuses](https://github.com/mysociety/alaveteli/wiki/Alaveteli's-request-statuses), it would be good to do so. Note that you can set how many days counts as "overdue" in the main site config file. |