Skip to content

Commit f598033

Browse files
authored
Update README.md
1 parent 178bab7 commit f598033

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,19 @@ Current state:
4040

4141
## Run the application
4242

43-
This is currently a simple HTML file that you can open with your web-browser : open the `example.html` file.
44-
The data displayed by example.html is loaded from `test_data.json`.
43+
There are two usable files that you can simply open with your browser (after cloning/downloading this whole folder):
4544

46-
The format of the json file must be like this:
45+
* `example.html`: as its name exaplains it, it's an example. The data displayed by example.html is loaded from `test_data.json`.
46+
* `app.html`: this is the final app that is currently under active development, you can try the implemented features, the format of the json file must be like this:
4747

4848
```json
49-
{"sig_name": ["My first signal", "My second signal"],"data":[[1, 1, 2, 1, 0, ...], [0.45,0.88, 0.98, 1.35...]]}
49+
{"values": [0.45,0.88, 0.98, 1.35...]}
5050
```
5151

52-
Where the sig_name list is a list of title for you signals, and data contains a list of list of numerics corresponding to your signals.
53-
5452

5553
## Development
5654

57-
This application is developped as a library file : `annotator.js`. `example.html` is an example usage of the library.
55+
This application is developped as a library file : `annotator.js` that might be used anywhere else, example.html and app.html are example usages of this library.
5856

5957
It only depends on the excellent Concrete.js library : http://www.concretejs.com/
6058

0 commit comments

Comments
 (0)