Add README file

openl10n · Dec 6, 2014 · 252e9e7 · 252e9e7
1 parent 736c29d
commit 252e9e7
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,3 @@
 /stages/*
-!/stages/deploy.rb.dist
+!/stages/example.rb.dist
 /vendor/*
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# OpenLocalization Capistrano
+
+Configuration files to deploy the [openl10n](https://github.com/openl10n/openl10n) project
+using [Capistrano](http://capistranorb.com/).
+
+## Install
+
+```bash
+gem install bundler
+bundle install
+```
+
+## Configure
+
+Copy the `stages/example.rb.dist` file and adapt it to your need.
+For instance, create a `production` environment:
+
+```bash
+cp stages/example.rb.dist stages/production.rb
+```
+
+## Deploy
+
+Deploy to this production environment:
+
+```bash
+bundle exec cap production deploy
+```
diff --git a/stages/deploy.rb.dist → stages/example.rb.dist b/stages/deploy.rb.dist → stages/example.rb.dist