summaryrefslogtreecommitdiff
path: root/config/customization
diff options
context:
space:
mode:
authorjessib <jessib@riseup.net>2013-11-18 09:57:02 -0800
committerjessib <jessib@riseup.net>2013-11-18 09:57:02 -0800
commitab2e014df85b7f931a717ed49d9b9678f6f1c5a0 (patch)
tree568a7e8cb47349431553ec5667dddcaaf57d206b /config/customization
parent3104677b8d96cd4a118022267abc7bed818f8ddd (diff)
parent7a107e0d38271e7103d3494e06d52f3434022f22 (diff)
Merge branch 'develop' into feature/rename_ticket_title_to_subject
Diffstat (limited to 'config/customization')
-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.