From 38963e49be5c8e14b3b8f685b57475a700173473 Mon Sep 17 00:00:00 2001 From: Azul Date: Tue, 8 Apr 2014 11:23:18 +0200 Subject: update documentation: included core in toplevel now we only include some engines - we don't build the whole webapp based on them. Reflecting this in the documentation. --- CUSTOM.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'CUSTOM.md') diff --git a/CUSTOM.md b/CUSTOM.md index 8671323..53e4d88 100644 --- a/CUSTOM.md +++ b/CUSTOM.md @@ -9,6 +9,6 @@ See config/customization/README.md Engines --------------------- -Leap Web is based on Engines. All things in `app` will overwrite the default behaviour. You can either create a new rails app and include the leap_web gem or clone the leap web repository and add your customizations to the `app` directory. +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. Not however that your app might still need to provide some functionality for the other engines to work. For example the users engine provides `current_user` and other methods. +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. -- cgit v1.2.3