Skip to content

Commit 2c12665

Browse files
committed
=BG= miscellaneous copy editing
1 parent b0d726d commit 2c12665

File tree

6 files changed

+41
-69
lines changed

6 files changed

+41
-69
lines changed

about/intro.md

Lines changed: 18 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,72 +2,54 @@
22

33
Angularity is a philosophy of development.
44

5-
Our focus is maintaining uniformity of development across groups of corporate developers who hold varying experience levels.
5+
Our focus is maintaining uniformity of development across groups of developers who hold varying experience levels.
66

7-
Our contributors hold a collective vision of best-practice Angular-js development and have condensed this into a set of tools and resources known as **Angularity**.
7+
Our contributors hold a collective vision of best-practice AngularJS development and have condensed this into a set of tools and resources known as **Angularity**.
88

99
## Features
1010

11-
Primarily Angularity is a javascript build tool build on [`node-js`](http://nodejs.org/). Its features include:
11+
Primarily Angularity is a [`node.js`](http://nodejs.org/) build tool. Its features include:
1212

1313
* Single `npm global install` for all projects.
14-
15-
* [`Ecmascript-6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29) syntax (using [`es6ify`](http://thlorenz.github.io/es6ify/)). Code import and ES-6 specific features.
16-
14+
* [`ECMAScript 6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29) syntax (using [`es6ify`](http://thlorenz.github.io/es6ify/)), including code import and other ES6 specific features.
1715
* [`jsHint`](http://www.jshint.com/about/) linting.
18-
1916
* [`SASS`](http://sass-lang.com/) 3.2 (using [`libsass`](http://libsass.org/)).
20-
2117
* [`Bourbon`](http://bourbon.io/) mixin library for SASS.
22-
2318
* [`Bower`](http://bower.io/) for web dependencies.
24-
2519
* Bower or node packages for shared code.
26-
2720
* Javascript unit testing (using [`Karma`](http://karma-runner.github.io/0.12/index.html) and [`Jasmine 2.0`](http://jasmine.github.io/2.0/introduction.html)).
28-
29-
* Sourcemaps for javascript (from Ecmascript-6 through minification).
30-
31-
* Sourcemaps for CSS.
32-
21+
* Source maps for Javascript (from ECMAScript 6 through minification).
22+
* Source maps for CSS.
3323
* Release versioning *[experimental]*.
3424

35-
At its heart, none of these features are specifically tied to [`Angular-js`](https://angularjs.org/). However much of the material you will find on this site is geared to Angular development.
25+
At its heart, none of these features are specifically tied to [`AngularJS`](https://angularjs.org/). However much of the material you will find on this site is geared to Angular development.
3626

3727
## Suitability
3828

39-
### You should use *angularity* when...
29+
### You should use *Angularity* when...
4030

4131
* You have several development teams and need uniformity of development.
42-
43-
* You develop with [`Angular-js`](https://angularjs.org/) and are open to working with [`Ecmascript-6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29), especially ES-6 Classes.
44-
32+
* You develop with [`AngularJS`](https://angularjs.org/) and are open to working with [`ECMAScript 6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29), especially ES6 Classes.
4533
* You use [`SASS`](http://sass-lang.com/), or are prepared to switch, and there are sufficient SASS mixins for you in the [`Bourbon`](http://bourbon.io/) library.
46-
47-
* You intend to `minify` or obfuscate your javascript.
48-
34+
* You intend to minify or obfuscate your Javascript.
4935
* You deploy to a [`Content Delivery Network (CDN)`](http://en.wikipedia.org/wiki/Content_delivery_network) and need to version your releases.
50-
51-
* You your browser support list permits [`Ecmascript 5.1`](http://kangax.github.io/compat-table/es5/).
52-
36+
* You your browser support list permits [`ECMAScript 5.1`](http://kangax.github.io/compat-table/es5/).
5337
* You would like your build tool to be an `npm global install`.
5438

55-
### You should avoid *angularity* when...
56-
57-
* You don't want to work with [`Ecmascript-6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29), are avoiding [`Traceur`](https://github.com/google/traceur-compiler) and its runtime, and can live without Object Orientated code.
39+
### You should avoid *Angularity* when...
5840

41+
* You don't want to work with [`ECMAScript 6`](http://en.wikipedia.org/wiki/ECMAScript#ECMAScript_Harmony_.286th_Edition.29), are avoiding [`Traceur`](https://github.com/google/traceur-compiler) and its runtime, and can live without Object Orientated code.
5942
* You want to use a CSS preprocessor other than [`SASS`](http://sass-lang.com/).
60-
6143
* You would like to use [`Compass`](http://compass-style.org/) with your SASS.
62-
6344
* You need to support [`PhantomJS`](http://phantomjs.org/) 1.x, `Internet Exporer 8` or lower.
6445

65-
### You should fork *angularity* when...
46+
### You should fork *Angularity* when...
6647

6748
* You want different build steps to those provided.
68-
6949
* You want features that are not on our roadmap.
7050

71-
Angularity is about uniformity. Per-project customisation is very small. If you develop a wide variety of applications you may ultimately find a conventional build (with something like [`Gulp`](http://gulpjs.com/)) will work better for you.
51+
Angularity is about uniformity.
52+
Per-project customisation should be minimal.
53+
If you develop a wide variety of applications you may ultimately find a conventional build (with something like [`Gulp`](http://gulpjs.com/)) will work better for you.
7254

73-
[Roadmap ⟶](roadmap.md)
55+
[Roadmap ⟶](roadmap.md)

about/roadmap.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,45 +7,32 @@ Regarding `documentation`.
77
The following items are listed in priority order but will necessarily be completed before version 1.0.0 release of the build tool.
88

99
* Getting started guide.
10-
1110
* Troubleshooting guide.
12-
1311
* Quick reference for development style, including comparison of ES5 and ES6 use cases.
14-
1512
* Manual for the build tool, including how it works.
1613

1714
## Build tool
1815

19-
Regarding `node-angularity`, the angularity build tool.
16+
Regarding `node-angularity`, the Angularity build tool.
2017

2118
### Version 1.0.0
2219

23-
* Ecmascript-5 development using `common-js` syntax *[Under consideration]*.
24-
20+
* ECMAScript 5 development using `common-js` syntax *[Under consideration]*.
2521
* Per-project configuration of `Karma` browser list and other selected unit testing settings.
26-
2722
* Refinement of release versioning, including per-project `CDN` settings.
28-
2923
* Generation of an `index.aspx` page in the release bundle and potentially other hooks to easily deploy on .NET systems.
3024

3125
### Version 1.x.0
3226

3327
* Build blocking on `js-hint` *[Under consideration]*.
34-
3528
* Generation of API documentation using [`JSdoc`](https://github.com/jsdoc3/jsdoc).
36-
3729
* Incremental compilation.
38-
39-
* Basic or experiemental support for [`Protractor`](https://docs.angularjs.org/guide/e2e-testing) end-to-end testing with local server or [`SauceLabs`](https://saucelabs.com/).
40-
30+
* Basic or experimental support for [`Protractor`](https://docs.angularjs.org/guide/e2e-testing) end-to-end testing with local server or [`SauceLabs`](https://saucelabs.com/).
4131
* Continuous Integration (`CI`) testing for the system itself *[Under consideration]*.
4232

4333
### Version 2.x.0
4434

4535
* `Karma` testing with [`PhantomJS 2.0`](http://ariya.ofilabs.com/2014/07/towards-phantomjs-2.html).
46-
4736
* Enhanced code-style enforcement using [`eslint (v0.10.0)`](https://github.com/eslint/eslint/wiki/Release-goals#v0100).
48-
4937
* Full support for [`Protractor`](https://docs.angularjs.org/guide/e2e-testing) with private [`Grid2`](https://code.google.com/p/selenium/wiki/Grid2) solution.
50-
51-
* Test console (HTML page) with real-time red/green indication for your unit tests *[under consideration]*.
38+
* Test console (HTML page) with real-time red/green indication for your unit tests *[under consideration]*.

getting-started/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ On **Windows** platform choose to **checkout Windows-style, commit Unit-style**
1313
[![](installation-git-1.png)]()
1414
[![](installation-git-2.png)]()
1515

16-
## Install node
16+
## Install node.js
1717

1818
[`http://nodejs.org/download/`](http://nodejs.org/download/)
1919

20-
Ensure that you choose the correct binary for your system. Meaning that 64bit systems should choose the 64bit binary.
20+
Ensure that you choose the correct binary for your system. Meaning that 64 bit systems should choose the 64 bit binary.
2121

2222
[![](installation-node.png)]()
2323

@@ -40,18 +40,18 @@ projects.
4040

4141
## Install Bower
4242

43-
Bower is a popular Frontend package manager that makes it easier to consume libraries for web development.
43+
Bower is a popular front end package manager that makes it easier to consume libraries for web development.
4444

4545
`npm install bower -g`
4646

4747
See more info on the [Bower website](http://bower.io).
4848

49-
## Install angularity
49+
## Install Angularity
5050

5151
Angularity is a **global** install.
5252

5353
`npm install angularity -g`
5454

55-
You are now ready to start an angularity project.
55+
You are now ready to start an Angularity project.
5656

57-
[Project Setup ⟶](project-setup.md)
57+
[Project Setup ⟶](project-setup.md)

getting-started/project-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Project setup
22

3-
Documentation will be forthcomming soon.
3+
Documentation is coming soon.

guide/composition.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ It is important not to hide composition. It should be done centrally, at the roo
55
In angular there are 2 different resources we must compose in order to build an application
66

77
* Using a **composition root** we map `directives`, `controllers`, and `services` into the `injector`.
8-
98
* Using **routing** we compose views from HTML `partials` and `controllers` for each different **application state**.
109

1110
## Composition Root
@@ -17,16 +16,20 @@ It is important for composition that each component (`directives`, `controllers`
1716
These components fit together all in one place - the **composition root**. The composition root may be organised into multiple files so long as this aids clarity.
1817

1918
We therefore need define only one `module` in the entire application. However that module must be dependent on the `templates` module. Meaning:
19+
2020
```
21-
angular.module('app', [ 'templates' ])
21+
angular.module('app', [ 'templates' ]);
2222
```
23-
This `templates` module is automatically generated from the HTML `partials`. The build system converts the HTML to a javascript routine that populates the angular **template cache**. This makes the `partials` immediately available to angular in a transparent manner.
23+
24+
This `templates` module is automatically generated from the HTML `partials`.
25+
The build system converts the HTML to a Javascript routine that populates the angular **template cache**.
26+
This makes the `partials` immediately available to angular in a transparent manner.
2427

2528
## Routing
2629

2730
> In a single page application it is critical that we encode **application state** in the **route**. This enables bookmarking and **deep linking** to reconstruct the page given only the URL.
2831
29-
For every change in view we need to encode `state` in the route. Where we have hierachical `state`, as with the angular [UI-router](https://github.com/angular-ui/ui-router/wiki), each layer of the state has its own HTML `partial` and recursively contains other views.
32+
For every change in view we need to encode `state` in the route. Where we have hierarchical `state`, as with the angular [UI-router](https://github.com/angular-ui/ui-router/wiki), each layer of the state has its own HTML `partial` and recursively contains other views.
3033

3134
> If you find your lowest-level partial is large it is likely you do **not** have sufficiently detailed `state`.
3235
@@ -68,4 +71,4 @@ export default function todoRoutes($stateProvider, $urlRouterProvider) {
6871
controller: MyController
6972
});
7073
}
71-
```
74+
```

index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ![](assets/logo.png) *Angularity*
1+
# ![Angularity Logo](assets/logo.png) *Angularity*
22

33
> Angularity is a philosophy of development.
44
5-
> Our focus is maintaining uniformity of development across groups of corporate developers who hold varying experience levels.
5+
> Our focus is maintaining uniformity of development across groups of developers who hold varying experience levels.
66
7-
> Our contributors hold a collective vision of best-practice Angular-js development and have condensed this into a set of tools and resources known as **Angularity**.
7+
> Our contributors hold a collective vision of best-practice AngularJS development and have condensed this into a set of tools and resources known as **Angularity**.
88
9-
[About ⟶](about/intro.md)
9+
[About ⟶](about/intro.md)

0 commit comments

Comments
 (0)