mirror of
https://github.com/koodiklinikka/koodiklinikka.fi.git
synced 2026-01-26 11:23:58 +00:00
update readme
This commit is contained in:
34
README.md
34
README.md
@@ -1,19 +1,10 @@
|
||||
# Project template for [gulp.js](http://gulpjs.com/)
|
||||
<img width="114px" height="257px" align="right" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"/>
|
||||
|
||||
### 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 <your project name>
|
||||
git clone git@github.com:koodiklinikka/koodiklinikka.fi.git <your project name>
|
||||
cd <your project name>
|
||||
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.
|
||||
|
||||
Reference in New Issue
Block a user