Skip to content

Commit

Permalink
Updated build guidelines in README.md to fix #23 (with 6652f4a)
Browse files Browse the repository at this point in the history
  • Loading branch information
pimterry committed Aug 3, 2013
1 parent bdc67ed commit d9291e0
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ loglevel is also available via [Bower](https://github.com/bower/bower) (`bower i

Alternatively if you just want to grab the file yourself, you can download either the current stable [production version][min] or the [development version][max] directly.

Finally, if you want to tweak loglevel to your own needs or you immediately need the cutting-edge version, clone this repo and see [Developing & Contributing](#developing--contributing) below for build instructions.

[min]: https://raw.github.com/pimterry/loglevel/master/dist/loglevel.min.js
[max]: https://raw.github.com/pimterry/loglevel/master/dist/loglevel.js

Expand Down Expand Up @@ -94,10 +96,10 @@ The loglevel API is extremely minimal. All methods are available on the root log

These enable or disable all log messages, and are equivalent to log.setLevel("trace") and log.setLevel("silent") respectively.

## Contributing & Developing
## Developing & Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

Builds can be run with grunt, run `grunt` to build a distributable version of the project (in /dist), or `grunt test` to just run the tests and linting. During development you can run `grunt watch` and it will monitor source files, and rerun the tests and linting as appropriate when they're changed.
Builds can be run with grunt: run `grunt dist` to build a distributable version of the project (in /dist), or `grunt test` to just run the tests and linting. During development you can run `grunt watch` and it will monitor source files, and rerun the tests and linting as appropriate when they're changed.

_Also, please don't manually edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!_

Expand All @@ -106,7 +108,7 @@ _Also, please don't manually edit files in the "dist" subdirectory as they are g
To do a release of loglevel:

* Update the version number in package.json and bower.json
* Run `grunt` to build a distributable version in dist/
* Run `grunt dist` to build a distributable version in dist/
* Update the release history in this file (below)
* Commit the built code, tagging it with the version number and a brief message about the release
* Push to Github
Expand Down

0 comments on commit d9291e0

Please sign in to comment.