mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-24 14:16:10 +03:00
Code Issues Projects Releases Wiki Activity
An open-source, web-based viewer for zoomable images, implemented in pure JavaScript.
327 Commits 12 Branches 28 Tags 35 MiB
JavaScript 94.8%
HTML 5.1%
CSS 0.1%
a7c96c56ef
Go to file
Benjamin Gilbert a7c96c56ef Drop MIT license; move BSD license to root directory 
All OpenSeadragon contributors have granted their permission for this
relicensing in #58.

Drop copyright statements for Ian Gilman and Christopher Thatcher as
they requested in #10.

Revert CodePlex Foundation copyright date to 2009 pursuant to discussion
in #10.
2013-05-10 00:16:55 -04:00
images several bug fixes and enhancements. legacy tile source issue discovered and corrected for images with width greater than height. adding basic support for sequenced tile sources including previous and next buttons. added mouse drag and scroll interactions for viewport navigator. 2012-04-03 03:08:27 -04:00
src Drop MIT license; move BSD license to root directory 2013-05-10 00:16:55 -04:00
test Getting started on a DZI-JSONp test; currently disabled 2013-05-09 11:03:31 -07:00
.gitignore Drop obsolete .gitignore entries 2013-04-22 20:28:13 -04:00
.travis.yml Grunt fix for Travis 2013-02-21 13:20:18 -08:00
changelog.txt Added in progress version 2013-05-09 11:07:17 -07:00
Gruntfile.js Drop MIT license; move BSD license to root directory 2013-05-10 00:16:55 -04:00
LICENSE.txt Drop MIT license; move BSD license to root directory 2013-05-10 00:16:55 -04:00
openseadragon.sublime-project Sublime project now excludes node_modules 2013-04-26 10:06:14 -07:00
package.json Upping version number to 0.9.126 2013-05-09 11:04:31 -07:00
README.md Drop MIT license; move BSD license to root directory 2013-05-10 00:16:55 -04:00

README.md

OpenSeadragon

An open-source, web-based viewer for zoomable images, implemented in pure JavaScript.

See it in action at http://openseadragon.github.io/.

Stable Builds

See our releases page.

First Time Setup

All command-line operations are scripted using Grunt which is based on Node.js. To get set up:

  1. Install Node, if you haven't already (available at the link above)
  2. Install the Grunt command line runner (if you haven't already); on the command line, run npm install -g grunt-cli
  3. Clone the openseadragon repository
  4. On the command line, go in to the openseadragon folder
  5. Run npm install

You're set... continue reading for build and test instructions.

Building from Source

To build, just run (on the command line, in the openseadragon folder):

grunt

If you want Grunt to watch your source files and rebuild every time you change one, use:

grunt watch

The built files appear in the build folder.

If you want to build tar and zip files for distribution (they will also appear in the build folder), use:

grunt package

Note that the build folder is masked with .gitignore; it's just for your local use, and won't be checked in to the repository.

You can also publish the built version to the site-build repository. This assumes you have cloned it next to this repository. The command is:

grunt publish

... which will delete the existing openseadragon folder, along with the .zip and .tar.gz files, out of the site-build folder and replace them with newly built ones from the source in this repository; you'll then need to commit the changes to site-build.

Testing

Our tests are based on QUnit and PhantomJS; they're both installed when you run npm install. At the moment we don't have much in the way of tests, but we're working to fix that. To run on the command line:

grunt test

If you wish to work interactively with the tests or test your changes:

grunt connect watch

and open http://localhost:8000/ in your browser

Contributing

OpenSeadragon is truly a community project; we welcome your involvement!

When contributing, please attempt to match the code style already in the codebase. Note that we use four spaces per indentation stop. For more thoughts on code style, see https://github.com/rwldrn/idiomatic.js/.

When fixing bugs and adding features, when appropriate please also:

  • Update changelog.txt
  • Add/update related unit tests
  • Update related doc comments

If you're new to the project, check out our good first bug issues for some places to dip your toe in the water.

License

OpenSeadragon is released under the New BSD license. For details, see the file LICENSE.txt.

Build Status