summaryrefslogtreecommitdiffstats
path: root/extra/sample_plugin/README
diff options
context:
space:
mode:
Diffstat (limited to 'extra/sample_plugin/README')
-rw-r--r--extra/sample_plugin/README24
1 files changed, 24 insertions, 0 deletions
diff --git a/extra/sample_plugin/README b/extra/sample_plugin/README
new file mode 100644
index 000000000..eed8b9a23
--- /dev/null
+++ b/extra/sample_plugin/README
@@ -0,0 +1,24 @@
+== Sample plugin
+
+This is a sample plugin for Redmine
+
+== Installation
+
+=== Adding plugin support to Redmine
+
+1. Install engines plugin
+ See: http://rails-engines.org/
+
+2. Uncomment this line in config/environment.rb:
+ config.plugins = ["engines", "*"]
+
+=== Plugin installation
+
+1. Copy the plugin directory into the vendor/plugins directory
+
+2. Migrate plugin:
+ rake db:migrate_plugins
+
+3. Start Redmine
+
+Installed plugins are listed on 'Admin -> Information' screen.