Skip to content
This repository has been archived by the owner on Mar 16, 2021. It is now read-only.

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Ferdinandi committed Oct 18, 2014
1 parent 41cfd96 commit 9317c8f
Showing 1 changed file with 22 additions and 26 deletions.
48 changes: 22 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,11 @@ My boilerplate for creating new web projects with [Gulp.js](http://gulpjs.com/).

1. [Getting Started](#getting-started)
2. [File Structure](#file-structure)
3. [Sass](#sass)
4. [JavaScript](#javascript)
5. [SVGs](#svgs)
6. [Continuous Integration](#continuous-integration)
7. [Options & Settings](#options-and-settings)
8. [Unit Testing](#unit-testing)
9. [License](#license)
10. [Changelog](#changelog)
3. [Working with the Source Files](#working-with-the-source-files)
4. [Options & Settings](#options-and-settings)
5. [Continuous Integration](#continuous-integration)
6. [License](#license)
7. [Changelog](#changelog)

## Getting Started

Expand Down Expand Up @@ -106,42 +103,30 @@ gulp-boilerplate/



## Sass

Sass files are located in `src` > `sass`. Gulp generates minified and unminified CSS files. It also includes [autoprefixer](https://github.com/postcss/autoprefixer), which adds vendor prefixes for you if required by the last two versions of a browser.
## Working with the Source Files

### Sass

Sass files are located in `src` > `sass`. Gulp generates minified and unminified CSS files. It also includes [autoprefixer](https://github.com/postcss/autoprefixer), which adds vendor prefixes for you if required by the last two versions of a browser.

## JavaScript
### JavaScript

JavaScript files are located in the `src` > `js` directory.

Files placed directly in the js folder will compile directly to `dist` > `js` as both minified and unminified files. Files placed in subdirectories will also be concatenated into a single file. For example, files in `js/detects` will compile into `detects.js`. Files directly under `js` will compile individually.

### Unit Testing
#### Unit Testing

Gulp Boilerplate is set up for unit testing with [Jasmine](http://jasmine.github.io/2.0/introduction.html). Add your tests to `test/spec/spec-myplugin.js`. Adjust filenames and references as needed.

Unit test results are printed in terminal, but you can also view them in a browser under `test/results/unit-tests.html`. Get a report of how much of your scripts is covered by testing under `test/coverage`.



## SVGs
### SVGs

SVG files placed in the `src` > `svg` directory will be compiled into a single SVG sprite called `icons.svg` in the `dist` > `svg` directory.



## Continuous Integration

This boilerplate includes a configuration file for [Travis CI](http://docs.travis-ci.com/user/getting-started/), a continuous integration service for GitHub.

If you sign-up and activate it for your repository, Travis CI will run your build and execute any processes to make sure everything is working as expected. This is particularly useful when working with a team or managing open source projects with multiple contributors.

The `.travis.yml` file is pre-configured for the boilerplate's build system. Even if you add files or update the Gulp tasks, you shouldn't need to change anything for it to work.



## Options and Settings

### Updating Project Details
Expand Down Expand Up @@ -187,6 +172,17 @@ var paths = {
```



## Continuous Integration

This boilerplate includes a configuration file for [Travis CI](http://docs.travis-ci.com/user/getting-started/), a continuous integration service for GitHub.

If you sign-up and activate it for your repository, Travis CI will run your build and execute any processes to make sure everything is working as expected. This is particularly useful when working with a team or managing open source projects with multiple contributors.

The `.travis.yml` file is pre-configured for the boilerplate's build system. Even if you add files or update the Gulp tasks, you shouldn't need to change anything for it to work.



## License

Gulp Boilerplate is licensed under the [MIT License](http://gomakethings.com/mit/).
Expand Down

0 comments on commit 9317c8f

Please sign in to comment.