diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..785b664 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +Alavetelitheme +============== + +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: + + * 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:: + + ./script/plugin install git://github.com/mysociety/alavetelitheme.git + +Look in the lib/ folder of the plugin to see how the overrides happen. + +Note that the `install.rb` plugin point sets up a symlink to include +local resource files within the Rails `public/` directory. + +Copyright (c) 2011 mySociety, released under the MIT license |