Skip to content

Commit

Permalink
updated dev documentation and removed old Cakefile - farewell
Browse files Browse the repository at this point in the history
  • Loading branch information
neocotic committed May 17, 2013
1 parent bc69e61 commit b63ba92
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 211 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -10,6 +10,7 @@ keeping things right.
* Clearly describe the issue including steps to reproduce when it is a bug
* Include the earliest version that you know has the issue
* Fork the repository on GitHub
* Read the `INSTALL.md` file

## Making Changes

Expand All @@ -23,6 +24,7 @@ keeping things right.
* Make commits of logical units
* Check for unnecessary whitespace with `git diff --check` before committing
* Make sure your commit messages are in the proper format
* Avoid updating the distributable file or annotated source code documentation

```
(#99999) Make the example in CONTRIBUTING imperative and concrete
Expand Down
202 changes: 0 additions & 202 deletions Cakefile

This file was deleted.

36 changes: 27 additions & 9 deletions INSTALL.md
@@ -1,24 +1,41 @@
# Build Requirements
This document is only relevant for those that want to contribute to the [Template][] open source
project (we love you guys!). If you are only interested in installing the extension you can do so
from our homepage:

http://template-extension.org

## Build Requirements

In order to build [Template][], you need to have the following install [git][] 1.7+ and [node.js][]
0.8+ (which includes [npm][]).

# Building
## Building

Follow these steps to build [Template][];

1. Clone a copy of the main [Template git repository](https://github.com/template-extension/template-chrome)
by running `git clone git://github.com/template-extension/template-chrome.git`
2. `cd` to the repository directory
3. Ensure you have all of the dependencies by entering `npm install`
4. To update the compiled and runnable version enter `cake build`
3. Ensure that you have all of the dependencies by entering `npm install`
4. Ensure that you can run [Grunt][] by using `npm install -g grunt-cli`
5. To update the compiled and runnable version enter `grunt build` (**Pro Tip:** Entering just `grunt` does exactly the same thing in this case)
* Outputs to the `bin` directory
5. To update the optimized distributable file enter `cake dist`
6. To update the optimized distributable file enter `grunt dist`
* Outputs to the `dist` directory
* Currently requires a `zip` utility to exist on the path
6. To update the documentation enter `cake docs`
7. To update the documentation enter `grunt docs`
* Outputs to the `docs` directory
* Not currently working on Windows as it uses linux shell commands

# Debugging
### Important

If you're planning on contributing to [Template][] please do **NOT** update the distributable file
or documentation (steps 6 and 7 respectively) when submitting a pull request. We will not accept
pull requests when these files have been changed as we run these ourselves when creating a new
release.

Read the `CONTRIBUTING.md` file for more information about submitting pull requests.

## Debugging

To run a locally built extension in [Google Chrome][] you can follow these steps;

1. Launch [Google Chrome][]
Expand All @@ -30,6 +47,7 @@ To run a locally built extension in [Google Chrome][] you can follow these steps

[git]: http://git-scm.com
[google chrome]: https://www.google.com/chrome
[grunt]: http://gruntjs.com
[node.js]: http://nodejs.org
[npm]: http://npmjs.org
[template]: http://template-extension.org

0 comments on commit b63ba92

Please sign in to comment.