Skip to content

Commit 2b177dd

Browse files
Add screenshot and usage instructions to readme
1 parent 9be9e30 commit 2b177dd

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# CrowdCurio Time Series Annotator Library
22

33
The CrowdCurio Time Series Annotation Library implements classification tasks for time series.
4+
5+
![A screenshot of the Time Series Annotator.](https://s3.amazonaws.com/curio-media/github-media/time-series-annotator.png)
6+
7+
## Features
8+
- Support for feature annotation tasks.
9+
- Support for interactive practice tasks.
10+
- Support for multivariate time series.
11+
- Support for medical time series in EDF format.
12+
- Integrated support for CrowdCurio.
13+
14+
## Build Process
15+
We use Browserify, Wachify and Uglify in our build processes. All three tools can be installed with NPM.
16+
17+
>npm install -g browserify
18+
19+
>npm install -g watchify
20+
21+
>npm install -g uglify-js
22+
23+
To build the script bundle *without* minification, run:
24+
>browserify lib/main.js -o bundle.js
25+
26+
To build *with* minification, run:
27+
>browserify lib/main.js | uglifyjs bundle.js
28+
29+
To watch for file changes and automatically bundle *without* minification, run:
30+
>watchify lib/main.js -o bundle.js
31+
32+
## Contact
33+
Mike Schaekermann, University of Waterloo

0 commit comments

Comments
 (0)