Files
impress.js/README.md
2016-06-25 23:10:14 +10:00

81 lines
3.0 KiB
Markdown

impress.js
============
[![CircleCI](https://circleci.com/gh/impress/impress.js.svg?style=svg)](https://circleci.com/gh/impress/impress.js)
It's a presentation framework based on the power of CSS3 transforms and
transitions in modern browsers and inspired by the idea behind prezi.com.
**WARNING**
impress.js may not help you if you have nothing interesting to say ;)
HOW TO USE IT
---------------
[Use the source](http://github.com/impress/impress.js/blob/master/index.html), Luke ;)
Please note that impress.js was created for developers. Some basic knowledge of html, css and
javascript is a prerequisite to install and use its features.
If you are a designer or novice developer that want to use impress.js,
[there are some projects](https://github.com/impress/impress.js/wiki/Examples-and-demos/5d887507caa5cf534eab6713d9adb3a5e7662459#authoring-tools) that aim to provide an editing tool for impress.js. They might be still in
development, but we hope they will manage to make impress.js more accessible to everyone.
EXAMPLES AND OTHER LEARNING RESOURCES
---------------------------------------
### Official demo
[impress.js demo](http://impress.github.io/impress.js/) by [@bartaz](http://twitter.com/bartaz)
### Examples and demos
More examples and demos can be found on [Examples and demos wiki page](http://github.com/impress/impress.js/wiki/Examples-and-demos).
Feel free to add your own example presentations (or websites) there.
### Other tutorials and learning resources
If you want to learn even more there is a [list of tutorials and other learning resources](https://github.com/impress/impress.js/wiki/impress.js-tutorials-and-other-learning-resources)
on the wiki, too.
There is also a book available about [Building impressive presentations with impress.js](http://www.packtpub.com/building-impressive-presentations-with-impressjs/book) by Rakhitha Nimesh Ratnayake.
WANT TO CONTRIBUTE?
---------------------
Please, read the [contributing guidelines](.github/CONTRIBUTING.md) on how to create [Issues](.github/CONTRIBUTING.md#issues) and [Pull Requests](.github/CONTRIBUTING.md#pull-requests).
**Note:** The team has changed, so there will be many changes in the upcoming versions.
If you need informations about versions, check the [changelog](CHANGELOG.md).
ABOUT THE NAME
----------------
impress.js name in [courtesy of @skuzniak](http://twitter.com/skuzniak/status/143627215165333504).
It's an (un)fortunate coincidence that a Open/LibreOffice presentation tool is called Impress ;)
Reference API
--------------
See the [Reference API](DOCUMENTATION.md)
BROWSER SUPPORT
-----------------
This project supports only the major [evergreen](http://eisenbergeffect.bluespire.com/evergreen-browsers/) desktop browsers that have implemented:
* [DataSet API](http://caniuse.com/#search=dataset)
* [ClassList API](http://caniuse.com/#search=classlist)
* [CSS 3D Transforms](http://caniuse.com/#search=css%203d)
* [CSS Transitions](http://caniuse.com/#search=css%20transition)
Copyright 2011-2016 Bartek Szopka - Released under the MIT [License](LICENSE)