Skip to content
This repository has been archived by the owner on Apr 5, 2023. It is now read-only.

Commit

Permalink
Update README and CONTRIBUTING to fix bugs, update for JavaScript/Emb…
Browse files Browse the repository at this point in the history
…er-CLI version

- Mentions Bower as necessary to start the demo app.
- Fixes issue #147 - Contribution Guidelines out of date. No src folder.
  Updates the folder structure description in contributing.md.

Code reviewer: @billylittlefield lgtmed
Closes #170
  • Loading branch information
metathinker committed Jul 29, 2016
1 parent 2363967 commit 66e8bdf
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 16 deletions.
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,25 @@ provide as much detail and context as possible.

## Writing Code in Ember Charts

Ember-charts is written in [CoffeeScript](http://coffeescript.org/) and compiled
into JavaScript using [Grunt](http://gruntjs.com/). Contributing to ember-charts
Ember Charts uses newer/non-portable JavaScript features, such as
ECMAScript 6 modules. It is compiled into older/portable JavaScript
using [Grunt](http://gruntjs.com/). Contributing to ember-charts
requires that you have grunt and NPM (for pulling in dependencies) locally
installed.

The `src` folder contains all the source code for the ember-charts project
itself. The `app` folder contains the sample app and documentation, and should
be updated whenever changes will add functionality, modify or remove existing
functionality, or change public APIs. The `dist` folder contains the compiled
ember-charts code and should not be directly modified but instead generated
using `grunt dist`.
The folder structure of Ember Charts is as follows:

- The `ember-charts/addon` folder contains almost all the source code for the
ES6 modules making up the ember-charts project itself.
- The `ember-charts/app` folder contains very thin wrappers around the modules
in the `addon` folder, used as part of the test executor and demo app.
- The `ember-charts/tests` folder contains the tests for Ember Charts, including:
* Unit tests: `ember-charts/tests/unit`
* The demo application you get with `ember serve`: `ember-charts/tests/dummy`
* Acceptance tests for the demo app: `ember-charts/tests/acceptance`
- The `ember-charts/dist` folder contains the compiled globals-based version
of the code in `ember-charts/addon`. It should not be directly modified
but instead generated using `grunt dist`.

## Pull requests

Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ Once it's installed, you can customize the look of ember-charts with CSS.

#### Installation with Bower (Globals-Based Version)

`bower install ember-charts --save`
```bash
npm install -g bower # install Bower
bower install ember-charts --save
```

Or, just include `dist/ember-charts.js` and `dist/ember-charts.css` in your app.

Expand All @@ -45,20 +48,21 @@ instructions under "Running Old Versions" to display the old guides.
After cloning this repo, install dependencies and run the demo app:

```bash
$ npm install
$ ember serve
npm install
bower install
ember serve
```

You can view the examples at http://localhost:4200.

You can run the tests at http://localhost:4200/tests.
Now you can:
- View the demos and read the documentation: http://localhost:4200
- Run tests: http://localhost:4200/tests

Before submitting a pull request, please compile the globals-based version of
Ember Charts (the `dist` folder):

```bash
$ npm install -g grunt-cli # install grunt
$ grunt dist
npm install -g grunt-cli # install grunt
grunt dist
```

## Dependencies
Expand Down

0 comments on commit 66e8bdf

Please sign in to comment.