You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@annotator.apache.org by bi...@apache.org on 2018/06/12 14:42:50 UTC
[incubator-annotator] 02/02: Improve readme; Add JSON test info
This is an automated email from the ASF dual-hosted git repository.
bigbluehat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git
commit c2213c8b0a6db4863e91a733e587e8dd802438a3
Author: Benjamin Young <by...@wiley.com>
AuthorDate: Tue Jun 12 10:42:36 2018 -0400
Improve readme; Add JSON test info
---
README.md | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ed76bc8..a81dd32 100644
--- a/README.md
+++ b/README.md
@@ -9,24 +9,32 @@
## Development
-Requirements:
+##### Requirements
- [node](https://nodejs.org) >= 6.x
- [yarn](https://www.yarnpkg.com/) >= 1.5.x
-Setup:
+##### Setup
```sh
$ yarn install
```
-Test:
+##### Test
```sh
$ yarn test
```
-Run localhost server:
+By default the Web Annotation JSON-related tests will skipped. To use those
+with a specific local file you can use the `--url` parameter plus a local file
+path.
+
+```sh
+$ yarn test --url ../anno1.json
+```
+
+##### Run localhost demo server
```sh
$ yarn start
--
To stop receiving notification emails like this one, please contact
bigbluehat@apache.org.