Skip to content

Commit

Permalink
README: include extra information for first timers (pull #1152)
Browse files Browse the repository at this point in the history
Getting started with this repo for the first time and found that there were some instructions/information that were missing. This adds the following updates:
- Add instruction to download JDK for testing in README
- Add information to set expectations when running `npm test`
  • Loading branch information
backwardok authored and ZoeBijl committed Oct 8, 2019
1 parent 545d852 commit bc5b7ef
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ Pull requests that contain linting errors will not be merged until the errors ar
1. Open the directory that contains your `aria-practices` repository in a terminal
1. Run `npm install`

The HTML validator also requires the installation of a JDK in order to run. If you don't already have a JDK installed, [download the latest JDK from Oracle](https://www.oracle.com/technetwork/java/javase/downloads/index.html).

It is also highly recommended that you use a code editor that supports these tools and [EditorConfig](http://editorconfig.org/).

#### HTML
Expand Down Expand Up @@ -77,7 +79,7 @@ npm run lint:js
### Test and fix your code

1. Open a terminal window to the directory that contains the `aria-practices` repository
1. The repository has a script defined that will test all JavaScript in the examples directory. To run it, execute the command `npm test`.
1. The repository has a script defined that will test all JavaScript in the examples directory. To run it, execute the command `npm test`. Note: this may take a few minutes to run and will open several browser windows during the test that will gain focus.
1. Many errors can be fixed automatically with the command `npm run fix`.
1. After running fix, test again to see what you need to fix manually.

Expand Down

0 comments on commit bc5b7ef

Please sign in to comment.