mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-21 20:56:09 +03:00
Code Issues Projects Releases Wiki Activity

Added jsdoc link to readme

Browse Source
This commit is contained in:
Ian Gilman 2013-11-27 09:28:34 -08:00
parent c11098326a
commit 95c945ca8a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,4 +1,4 @@
# OpenSeadragon # OpenSeadragon
An open-source, web-based viewer for zoomable images, implemented in pure JavaScript. An open-source, web-based viewer for zoomable images, implemented in pure JavaScript.
@ -58,7 +58,7 @@ If you wish to work interactively with the tests or test your changes:
grunt connect watch grunt connect watch
and open `http://localhost:8000/test/test.html` in your browser. and open `http://localhost:8000/test/test.html` in your browser.
Another good page, if you want to interactively test out your changes, is `http://localhost:8000/test/demo/basic.html`. Another good page, if you want to interactively test out your changes, is `http://localhost:8000/test/demo/basic.html`.
@ -70,7 +70,7 @@ When contributing, please attempt to match the code style already in the codebas
When fixing bugs and adding features, when appropriate please also: When fixing bugs and adding features, when appropriate please also:
* Update related doc comments * Update related doc comments (we use [JSDoc 3](http://usejsdoc.org/))
* Add/update related unit tests * Add/update related unit tests
If you're new to the project, check out our [good first bug](https://github.com/openseadragon/openseadragon/issues?labels=good+first+bug&page=1&state=open) issues for some places to dip your toe in the water. If you're new to the project, check out our [good first bug](https://github.com/openseadragon/openseadragon/issues?labels=good+first+bug&page=1&state=open) issues for some places to dip your toe in the water.