Skip to content

Commit d4f5fbd

Browse files
updated readme
1 parent 156c95d commit d4f5fbd

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

Diff for: README.md

+7-15
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# StreamBuilder
22

3-
_WARNING: This documentation is out of date. New docs coming in the next 24-48 hours. (June 16th, 2016)
4-
53
##What it is
6-
StreamBuilder is an automated build environment well suited for HTML, CSS and JavaScript prototyping. It runs on the (streaming) build system gulp.js. It uses the Jade template language to modularize html into templates, allowing developers to take a DRY approach to front-end development. Also included is the Sass CSS extension language.
4+
StreamBuilder is an automated build environment well suited for HTML, CSS and JavaScript prototyping. It runs on the (streaming) build system gulp.js. Also included is the Sass CSS extension language.
75

86
*__StreamBuilder focuses on four tasks to make your job easier.__*
97

108
1. Compile SCSS into minified CSS.
119
2. Minify JavaScript.
12-
3. Allow HTML to be templatized so things like headers, footers and common include items can be more easily maintained.
10+
3. Move your html/css/JavaScripts and images from the source (working) folder, to the destination folder.
1311
4. Refresh your browser for you as you make changes to your source files. StreamBuilder will create a proxy server and listen on port 3000 of your localhost environment (example: http://localhost:3000/streambuilder/dist).
1412

1513
*__StreamBuilder's workflow__*
1614

17-
You work from the /src directory and everytime you save a file; be it SCSS, JavaScript or Jade templates, StreamBuilder compiles SCSS into CSS, minifies JavaScripts and compiles Jade templates to HTML and places the compiled files in the /dist directory.
15+
You work from the /src directory and everytime you save a file; be it SCSS, JavaScript or html templates, StreamBuilder compiles SCSS into CSS, minifies JavaScripts and places the compiled files in the /dist directory.
1816

1917
##Requirements
2018
Requires [Nodejs](https://nodejs.org/)
@@ -26,21 +24,15 @@ Note: if you run GNU/Linux you can now get the most recent version of Node with
2624
2. Install the node modules listed in the package.json file globally. I.e., `sudo npm install -g <node_module>`
2725
3. From a terminal `cd path/to/streambuilder`
2826
4. `npm update` This will create a new directory "node_modules" where NPM will install all the required node modules.
29-
5. `gulp`
27+
5. Run `gulp`
3028

3129
## Advanced configuration
3230
You can change anything and everything about StreamBuilder by editing the gulpfile.js. By default StreamBuilder compiles everything to the /dist folder. You can chage this behavior (as well as the URL of the project) by editing the `conf_xyz_dest` vars in the top of gulpfile.js.
3331

34-
StreamBuilder comes bundles with SCSS and Jade templates. You can also change this by removing the gulp-jade and gulp-scss modules and installing the css pre-processor and template language of your choice then editing the tasks in gulpfile.js. You can find additional modules at [NPM](https://www.npmjs.com/).
32+
StreamBuilder comes bundles with SCSS support. You can change this by removing the gulp-scss modules and installing the css pre-processor and template language of your choice then editing the tasks in gulpfile.js. You can find additional modules at [NPM](https://www.npmjs.com/).
3533

3634
##Goodies
37-
Out of the box StreamBuilder will create a single page scroller website and includes [Modernizr](http://modernizr.com/) and [jQuery](https://jquery.com/) via [Bower](http://bower.io/).
38-
39-
In some cases it may be helpful to delete the entire destination folder and start over. You can do this by running gulp with the clean flag.
40-
41-
`gulp --clean`
42-
43-
Note: this deletes the entire destination folder as set in the gulpfile.js `conf_output_dest` var.
35+
Out of the box StreamBuilder will create a single page website.
4436

4537
##Getting Help
46-
If you find a bug or want to see a feature, file it in the [issues section](https://github.com/prawnstar/streambuilder/issues).
38+
If you find a bug or want to see a feature, file it in the [issues section](https://github.com/digi-brains/StreamBuilder/issues).

0 commit comments

Comments
 (0)