aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index de025dcb2..d4cd0013e 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,22 @@ wiki](https://github.com/mysociety/alaveteli/wiki/Home/), and upgrade
notes in the [`doc/`
folder](https://github.com/mysociety/alaveteli/tree/master/doc/CHANGES.md)
+## Installing
+
+We've been working hard to make Alaveteli easy to install and re-use anywhere. Please
+see [the project website](http://alaveteli.org) for instructions on installing Alaveteli.
+
+## Compatibility
+
+Every Alaveteli commit is tested by Travis on the [following Ruby platforms](https://github.com/mysociety/alaveteli/blob/master/.travis.yml#L7)
+
+* ruby-1.8.7
+* ruby-1.9.3
+* ruby-2.0.0
+
+
+If you use a ruby version management tool (such as RVM or .rbenv) and want to use the default development version used by the alaveteli team (currently 2.0.0), you can create a `.ruby-version` symlink with a target of `.ruby-version.example` to switch to that automatically in the project directory.
+
## How to contribute
If you find what looks like a bug: