summaryrefslogtreecommitdiff
path: root/config/customization
diff options
context:
space:
mode:
authorazul <azul@riseup.net>2013-11-15 01:33:03 -0800
committerazul <azul@riseup.net>2013-11-15 01:33:03 -0800
commit7a107e0d38271e7103d3494e06d52f3434022f22 (patch)
treeb2a049aa1700dbcda01111bd60d656665aa75f55 /config/customization
parentb131fd4f4d7fd23e787b18c207224216860081bb (diff)
parent4193a94b4cc5b5cabbace8311562c0ca88a79f74 (diff)
Merge pull request #113 from elijh/feature/customize
Feature/customize
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.