1 | Overview |
---|
2 | -------- |
---|
3 | |
---|
4 | Shadowbox is a flexible media viewer that supports all of the web's most popular |
---|
5 | media publishing formats. Shadowbox is written entirely in JavaScript and CSS and |
---|
6 | is highly customizable. Using Shadowbox, website authors can display a wide |
---|
7 | assortment of media in all major browsers without navigating users away from the |
---|
8 | linking page. |
---|
9 | |
---|
10 | For more information, please see http://shadowbox-js.com/. |
---|
11 | |
---|
12 | Installation and Usage |
---|
13 | ---------------------- |
---|
14 | |
---|
15 | For detailed installation and usage instructions, please see the usage page at |
---|
16 | http://shadowbox-js.com/usage.html. |
---|
17 | |
---|
18 | How to Build |
---|
19 | ------------ |
---|
20 | |
---|
21 | IMPORTANT: The following instructions are for those who would like to create a custom build |
---|
22 | of Shadowbox on their own machines. Most users will not want to do this and instead should |
---|
23 | simply download, install, and use Shadowbox as described on the Shadowbox website at |
---|
24 | http://shadowbox-js.com/usage.html. |
---|
25 | |
---|
26 | In order to build Shadowbox on your own machine you must have the Ruby programming |
---|
27 | language (http://ruby-lang.org/) installed as well as the Rake build tool |
---|
28 | (http://rake.rubyforge.org/). Simply edit the parameters in `build.yml` to your liking |
---|
29 | and run the following command from the project root directory: |
---|
30 | |
---|
31 | $ rake |
---|
32 | |
---|
33 | Note: If you want to build a compressed version of the code (which is the default), you |
---|
34 | will also need Java installed. You can always use the web interface on the Shadowbox website |
---|
35 | (http://shadowbox-js.com/download.html) to build your own version of the code if you are |
---|
36 | unable to do it on your own. |
---|
37 | |
---|
38 | How to Run Tests and Examples |
---|
39 | ----------------------------- |
---|
40 | |
---|
41 | The Shadowbox test suite is written with QUnit (http://github.com/jquery/qunit). To run the |
---|
42 | tests, you first need to build the code using the `build:tests` Rake task. |
---|
43 | |
---|
44 | $ rake build:tests |
---|
45 | |
---|
46 | Once you have built the code, open `tests/index.html` in your browser of choice. Likewise, |
---|
47 | to run any of the examples you first need to run the `build:examples` Rake task before |
---|
48 | opening the example HTML file in your browser. |
---|
49 | |
---|
50 | $ rake build:examples |
---|
51 | |
---|
52 | How to Contribute |
---|
53 | ----------------- |
---|
54 | |
---|
55 | If you would like to contribute to the project please email me your contribution/patch |
---|
56 | at mjijackson@gmail.com. I'm more than happy to accomodate fixes and modifications that |
---|
57 | make Shadowbox a better product. |
---|
58 | |
---|
59 | Bugs |
---|
60 | ---- |
---|
61 | |
---|
62 | Please report any bugs that you may find at http://github.com/mjijackson/shadowbox/issues. |
---|
63 | |
---|
64 | License |
---|
65 | ------- |
---|
66 | |
---|
67 | The Shadowbox license is available online at http://shadowbox-js.com/LICENSE. |
---|
68 | |
---|
69 | Credits |
---|
70 | ------- |
---|
71 | |
---|
72 | Shadowbox employs several open source libraries including Sizzle.js (http://sizzlejs.com/) |
---|
73 | and swfobject (http://code.google.com/p/swfobject/). |
---|