libSass Package Skeleton


Description

Bootstrap a new [libSass] package in less than a minute.

This skeleton uses [libSass].
For [Ruby Sass][Sass], use [makenew/sass-package].

[libSass]: http://libsass.org/
[makenew/sass-package]: https://github.com/makenew/sass-package
[Sass]: http://sass-lang.com/

$3

* [Bower] and [npm] package structure.
* [Grunt] tasks for development.
* [Travis CI] ready.
* [EditorConfig].
* Badges from [Shields.io].

[Bower]: http://bower.io/
[EditorConfig]: http://editorconfig.org/
[Grunt]: http://gruntjs.com/
[npm]: https://www.npmjs.com/
[Shields.io]: http://shields.io/
[Travis CI]: https://travis-ci.org/

$3

1. Clone this repository or download a [release][Releases].

2. Run ./makenew.sh and follow the prompts.
This will replace the boilerplate, delete itself,
and stage changes for commit.
This script assumes the project repository will be hosted on GitHub.
For an alternative location, you must update the URLs manually.

3. Fill in the README Description section.

4. If [choosing a license][Choose a license] other than the one provided:
update LICENSE.txt, the README License section,
package.json, and bower.json with your chosen license.

[Choose a license]: http://choosealicense.com/
[Releases]: https://github.com/makenew/libsass-package/releases
[The Unlicense]: http://unlicense.org/UNLICENSE

$3

If you want to pull in future updates from this skeleton,
you can fetch and merge in changes from this repository.

If this repository is already set as origin,
rename it to upstream with

``
$ git remote rename origin upstream
`

and then configure your origin branch as normal.

Otherwise, add this as a new remote with

`
$ git remote add upstream https://github.com/makenew/libsass-package.git
`

You can then fetch and merge changes with

`
$ git fetch upstream
$ git merge upstream/master
`

#### Changelog

Note that CHANGELOG.md is just a template for this skeleton.
The actual changes for this project are documented in the commit history
and summarized under [Releases].

Installation

The recommended method is to add this as a dependency
to your project using [npm] with

`
$ npm install --save makenew-libsass-package
`

or [Bower] with

`
$ bower install --save makenew-libsass-package
`

Alternatively, you can download a [release][Releases]
or clone the repository directly.

[Bower]: http://bower.io/
[npm]: https://www.npmjs.com/
[Releases]: https://github.com/makenew/libsass-package/releases

Development and Testing

$3

The [makenew-libsass-package source] is hosted on GitHub.
Clone the project with

`
$ git clone https://github.com/makenew/libsass-package.git
`

[makenew-libsass-package source]: https://github.com/makenew/libsass-package

$3

You will need [Node.js] with [npm].

Install the development dependencies with

`
$ npm install
`

[Node.js]: https://nodejs.org/

$3

Install any Bower dependencies and execute the default build task with

`
$ npm start
`

$3

Optionally, you may run additional development tasks with [Grunt].
Install it with

`
$ npm install --global grunt-cli
`

Run $ grunt --help to see all Grunt tasks.

`
clean # Clean files and folders. *
watch # Run predefined tasks whenever watched files change.
sass # Compile Sass to CSS *
default # Alias for "clean", "sass" tasks.
`

[Grunt]: http://gruntjs.com/

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/makenew/libsass-package/fork).
2. Create your feature branch (git checkout -b my-new-feature).
3. Make changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin my-new-feature`).
6. Create a new Pull Request.

License

This software can be used freely, see [The Unlicense].
The copyright text appearing below and elsewhere in this repository
is for demonstration purposes only and does not apply to this software.

This Sass package is licensed under the MIT license.

Warranty

This software is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular
purpose.