summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAzul <azul@riseup.net>2014-02-05 12:48:28 +0100
committerAzul <azul@riseup.net>2014-02-05 12:48:28 +0100
commit1373f67a4963dbfbce3d5a8af26a7ee628de0624 (patch)
treea4cfa79be6322286ce3cdaf7b23ad1d487027f07
parentcde0842592f3c6150616deabd8665e1fb8cf4e08 (diff)
keep the README.md in the webapp customization
This way it will not be listed as deleted by git - see #4953. It's also quite useful to have a bit of explaination in that directory.
-rw-r--r--files/webapp/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/files/webapp/README.md b/files/webapp/README.md
new file mode 100644
index 0000000..9c3e434
--- /dev/null
+++ b/files/webapp/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.