From 40269426cfd34dfb6128f4922fdbd651ab1fb7eb Mon Sep 17 00:00:00 2001 From: Riku Rouvila Date: Thu, 15 Jan 2015 19:39:29 +0200 Subject: [PATCH] update readme --- README.md | 34 ++-------------------------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index d8ac91c..ecf41c8 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ -# Project template for [gulp.js](http://gulpjs.com/) - - -### What it does -* [Jade](http://jade-lang.com) files to HTML -* [Stylus](http://learnboost.github.io/stylus) files to CSS -* [CoffeeScript](http://coffeescript.org/) files to Javascript through [browserify](http://browserify.org/) - * You are able to use 'require' in your client-side code -* Serves your static files to localhost:9001 -* Reloads your browser with LiveReload when files change +# KOODIKLINIKKA ## Getting things up and running - Install [Node.js](http://nodejs.org) ``` - git clone git@github.com:leonidas/gulp-project-template.git + git clone git@github.com:koodiklinikka/koodiklinikka.fi.git cd npm install npm start @@ -38,24 +29,3 @@ Minification, uglification and other tasks you're expected to run before deployi * **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**. - -### Using JavaScript instead of CoffeeScript -Remove coffeeify transform from package.json file (browserify.transform field) -```diff - "transform": [ -- "coffeeify", - "debowerify", - "deamdify" - ] -``` - -and change the ".coffee" extension to ".js" from gulpfile.coffee -```diff -config = - scripts: -- source: './src/coffee/main.coffee' -- extensions: ['.coffee'] -+ source: './src/js/main.js' -+ extensions: ['.js'] -``` -You also can change the directory name to scripts or what ever.