summaryrefslogtreecommitdiff
path: root/doc/CUSTOM.md
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2015-04-29 13:51:11 -0700
committerelijah <elijah@riseup.net>2015-04-29 13:51:11 -0700
commite99856e5338424b36884e21db1f1399f4753ab3a (patch)
tree1e11e8b27c63f848a876f8f5dfca2e3b4eb5deb7 /doc/CUSTOM.md
parent73fd6f5ef05adf5abdb31bcca4377c0ee7ca052b (diff)
clean up docs
Diffstat (limited to 'doc/CUSTOM.md')
-rw-r--r--doc/CUSTOM.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/CUSTOM.md b/doc/CUSTOM.md
new file mode 100644
index 0000000..53e4d88
--- /dev/null
+++ b/doc/CUSTOM.md
@@ -0,0 +1,14 @@
+Customization
+==============================
+
+Customization directory
+---------------------------------------
+
+See config/customization/README.md
+
+Engines
+---------------------
+
+Leap Web includes some Engines. All things in `app` will overwrite the engine behaviour. You can clone the leap web repository and add your customizations to the `app` directory. Including leap_web as a gem is currently not supported. It should not require too much work though and we would be happy to include the changes required.
+
+If you have no use for one of the engines you can remove it from the Gemfile. Engines should really be plugins - no other engines should depend upon them. If you need functionality in different engines it should probably go into the toplevel. The 'users' engine will soon become part of the main webapp for that reason.