Include documentation in the application

This commit is contained in:
Frederic Guillot
2015-08-29 20:00:53 -04:00
parent ef087f5e22
commit 6c711f696f
135 changed files with 285 additions and 38 deletions

25
doc/assets.markdown Normal file
View File

@@ -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).