summaryrefslogtreecommitdiff
path: root/config/customization/README.md
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2013-11-14 02:19:03 -0800
committerelijah <elijah@riseup.net>2013-11-14 02:23:38 -0800
commit10be8c0073b67dcfb7925996e81c2e717f8b499e (patch)
treef96e03786c87baf2f501e34e46153cd2a64f1ef5 /config/customization/README.md
parent8c19b447dec3982107f93ea1ae2626f844045249 (diff)
added support for easier customizations via "config/customization" directory
Diffstat (limited to 'config/customization/README.md')
-rw-r--r--config/customization/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/config/customization/README.md b/config/customization/README.md
new file mode 100644
index 0000000..9c3e434
--- /dev/null
+++ b/config/customization/README.md
@@ -0,0 +1,27 @@
+Customizing LEAP Webapp
+============================================
+
+By default, this directory is empty. Any file you place here will override the default files for the application.
+
+For example:
+
+ stylesheets/ -- overrides files Rails.root/app/assets/stylesheets
+ tail.scss -- included before all others
+ head.scss -- included after all others
+
+ public/ -- overrides files in Rails.root/public
+ favicon.ico -- custom favicon
+ img/ -- customary directory to put images in
+
+ views/ -- overrides files Rails.root/app/views
+ home/
+ index.html.haml -- this file is what shows up on the home page
+
+ locales/ -- overrides files in Rails.root/config/locales
+ en.yml -- overrides for English
+ de.yml -- overrides for German
+ and so on...
+
+For most changes, the web application must be restarted after any changes are made to the customization directory.
+
+Sometimes a `rake tmp:clear` and a rails restart is required to pick up a new stylesheet.