diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/INSTALL.md | 12 | ||||
| -rw-r--r-- | doc/THEMES.md | 14 | ||||
| -rw-r--r-- | doc/TRANSLATE.md | 7 |
3 files changed, 21 insertions, 12 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 325ccfbdd..588f8e4fe 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -19,12 +19,11 @@ Next, get hold of the Alaveteli source code from github: git clone https://github.com/sebbacon/alaveteli.git cd alaveteli -This will get the current stable release from the master branch (which -always contains the latest release). If you are a developer and want -to add or try new features, you might want to swap to the development -branch: +This will get the development branch, which has the latest (possibly +buggy) code. If you don't want to add or try new features, swap to the +master branch (which always contains the latest stable release): - git checkout develop + git checkout master # Install system dependencies @@ -318,6 +317,9 @@ like `!!(*= $this *)!!`. The variables are: * `user`: the user that the software runs as * `site`: a string to identify your alaveteli instance +There is a dumb python script at `script/make-crontab` which you can +edit and run to do some basic substitution for you. + One of the cron jobs refers to a script at `/etc/init.d/foi-alert-tracks`. This is an init script, a copy of which lives in `config/alert-tracks-debian.ugly`. As with the cron diff --git a/doc/THEMES.md b/doc/THEMES.md index 50335c082..e33371df7 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. + +You can also install the sample theme by hand, by running: ./script/plugin install git://github.com/sebbacon/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. diff --git a/doc/TRANSLATE.md b/doc/TRANSLATE.md index 8330c5f24..543c16cd9 100644 --- a/doc/TRANSLATE.md +++ b/doc/TRANSLATE.md @@ -59,11 +59,14 @@ must: * regenerate the POT file and individual PO files for each language, using `bundle exec rake gettext:store_model_attributes`, followed by `bundle exec rake - rake gettext:find` + gettext:find` + * careful of including msgids from themes in `vendor/plugin`; + you might want to move them out of the way before running + the above commands * this updates the PO template, but also merges it with the individual PO files, marking strings that have only changed slightly as "fuzzy" - * reupload (`tx push -s -t`) the POT and PO files to Transifex to the + * reupload (`tx push -s -t`) the POT and PO files to Transifex from the current release branch * The point of uploading the PO files is that Transifex converts the "fuzzy" suggestions from Transifex into |