From 2ac09dba69144417838ae86b948132065d5dfd3a Mon Sep 17 00:00:00 2001 From: Riku Rouvila Date: Thu, 21 May 2015 22:59:40 +0300 Subject: [PATCH] update readme --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3688099..9e8ee9d 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,24 @@ Minification, uglification and other tasks you're expected to run before deployi NODE_ENV=production npm run build ## Development guidelines -* **public** - directory should be dedicated only to compiled/copied files from **src** - directory. - It should be possible to delete directory completely and after **npm start** or **npm run build** everything should be as they were before the deletion. -* All backend dependencies should be installed with **npm**. Browser dependencies should be installed with **bower** or with **npm**. +#### Directory structure + +**public** - directory should be dedicated only to compiled/copied files from **src** - directory. + It should be possible to delete directory completely and after **npm start** or **npm run build** everything should be as they were before the deletion. + +#### Dependencies +All dependencies are meant to be installed with **bower** or with **npm**. +* JavaScript-files from both **bower_components** and **node_modules** can be *require()*'d in client-side modules. +* CSS files can be [imported](https://learnboost.github.io/stylus/docs/import.html) from **bower_components** and **node_modules** using relative path from the stylus file to the css file e.g `@import '../../bower_components/bootstrap/dist/css/bootstrap.css'` +* You can either create a new gulp task for copying other assets from directories mentioned above or use an array as a value for [assets sources](https://github.com/leonidas/gulp-project-template/blob/master/gulpfile.js#L38) e.g `source: ['./src/assets/**/*.*', 'bower_components/bootstrap/fonts*/*.*']` *(notice the asterisk after 'fonts'? It makes gulp copy the whole directory instead of just the files inside of it)* + +## Suggested development tools + +* [eslint](http://eslint.org/) + * When used as an editor plugin (for example. [SublimeLinter](http://sublimelinter.readthedocs.org/en/latest/) + [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint)), gives you immediate feedback about your code and can find bugs, potential problem areas, poor coding styles and stylistic issues. + + +## FAQ -# FAQ ### I want to use CoffeeScript instead of JavaScript Check out the [coffee branch](https://github.com/leonidas/gulp-project-template/tree/coffee)