Skip to content

Commit 02424e6

Browse files
committed
Added Building section
1 parent 612a195 commit 02424e6

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

README.md

+24-11
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
1-
# Referencing Bug Tracker Tickets
1+
## Referencing Bug Tracker Tickets
22

33
* Pull requests for changes that were requested or recommended via the [jQuery Bug Tracker](http://bugs.jquery.com) should include a link back to the relevant ticket.
44

5-
# Style Guidelines
5+
## Building
66

7-
## Prose Style & Grammar
7+
### Requirements
8+
* <a href="http://www.xmlsoft.org/">libxml2</a>
9+
* <a href="http://xmlsoft.org/XSLT/">libxslt</a>
810

9-
###Sentence Structure
11+
The `xmllint` and `xsltproc` utilities need to be in your path. If you are on Windows, you can get libxml2 and libxslt from <a href="http://sourceforge.net/projects/gnuwin32/files/">GnuWin32</a>.
12+
13+
### Build
14+
15+
1. `npm install`
16+
2. `grunt`
17+
18+
## Style Guidelines
19+
20+
### Prose Style & Grammar
21+
22+
#### Sentence Structure
1023

1124
* Write in clear, easy-to-understand statements.
1225
* Keep sentences short and to the point.
1326

14-
###Spelling
27+
#### Spelling
1528
* The documentation standardizes on American English spelling. For example:
1629
* **Yes**: color, while, among, customize
1730
* **No**: colour, whilst, amongst, customise
1831

19-
### Pronoun Usage
32+
#### Pronoun Usage
2033
* Use second-person pronoun ("you") when necessary, but try to avoid it.
2134
* Favor the definite article ("the") over second-person possesive ("your").
2235
* **Yes**: Insert the paragraph after the unordered list.
@@ -25,29 +38,29 @@
2538
* **Yes**: The `.insertAfter()` method here adds an unordered list beneath the paragraph.
2639
* **No**: And now we have our paragraph beneath the unordered list.
2740

28-
### "Voice"
41+
#### "Voice"
2942
* Prefer active voice over passive.
3043
* **Active**: Calling `.click()` binds a click handler to the elements in the collection
3144
* **Passive**: Click handlers are bound to elements in the collection when `.click()` is called
3245

33-
## Code Style
46+
### Code Style
3447
Code in the API documentation should follow the [jQuery Core Style Guide](http://docs.jquery.com/JQuery_Core_Style_Guidelines) with the following addition and exception:
3548

3649
* **Document ready syntax**: Use `$( document ).ready(function() {` instead of `$(function() {` as it's harder for new users to distinguish the difference between the latter and an IIFE.
3750
* **Indentation**: Core guidelines say to use tabs. In API documentation, *use 2 spaces instead*. This helps keep the line width manageable and avoid horizontal scrollbars.
3851

39-
### Code within prose content (paragraphs and the like):
52+
#### Code within prose content (paragraphs and the like):
4053
* Methods: use a dot, followed by the method name, followed by parentheses: e.g. The `.focus()` method is a shortcut for `.bind('focus', handler)` in the first and second variations, and `.trigger('focus')` in the third.
4154
* Properties: use a dot, followed by the property name: e.g. `.length`.
4255
* Functions: use the function name, followed by parentheses: `myFunction()`.
4356

44-
### Examples
57+
#### Examples
4558
* Examples should indicate what the expected result will be before presenting the code. This makes code clearer and skimming easier, especially for newer coders who may not understand what is supposed to be happening from reading the code itself.
4659
* **Yes**: Find all p elements that are children of a div element and apply a border to them.
4760
* **No**: Find all p elements that are children of a div element.
4861
* Make your example easy to follow with good comments so that the explanation isn't necessary.
4962

50-
## Rhetorical Context
63+
### Rhetorical Context
5164
* Subject
5265
* The entirety of jQuery's public API
5366
* Audience

0 commit comments

Comments
 (0)