summaryrefslogtreecommitdiff
path: root/doc/assets.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/assets.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/assets.markdown')
-rw-r--r--doc/assets.markdown25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/assets.markdown b/doc/assets.markdown
new file mode 100644
index 00000000..29bf515b
--- /dev/null
+++ b/doc/assets.markdown
@@ -0,0 +1,25 @@
+How to build assets (Javascript and CSS files)
+==============================================
+
+Stylesheet and Javascript files are merged together and minified.
+
+- Original CSS files are stored in the folder `assets/css/src/*.css`
+- Original Javascript code is stored in the folder `assets/js/src/*.js`
+
+Requirements
+------------
+
+- Unix operating system
+- make
+- yuicompressor in your path (`brew install yuicompressor`)
+
+Build assets
+------------
+
+- Build Stylesheet files: `make css`
+- Build Javascript files: `make js`
+- Build both: `make`
+
+This script generates the files `assets/css/app.css` and `assets/js/app.js`.
+
+This tool is only available in the repository (development version).