Update README.md to match the new repository structure

Explains the plugins, lib and build.js, etc.

Also delete the contributor guidelines in .github. We won't be using
those going forward, what README.md says is enough.
This commit is contained in:
Henrik Ingo
2017-10-30 19:39:23 +02:00
parent 443a4a82c1
commit 3ef230053e
4 changed files with 55 additions and 52 deletions

View File

@@ -1,30 +0,0 @@
Issues
------
If you've found a bug or have a great idea for a new feature that will help **all users** of impress.js, let us know by [adding your suggestion]
(https://github.com/bartaz/impress.js/issues/new) to the [issue tracker](https://github.com/bartaz/impress.js/issues).
Guidelines:
* If reporting a bug, please provide a [simplified example](https://sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/).
Pull Requests
-------------
[Pull Requests](https://help.github.com/articles/using-pull-requests/) should be opened against the [master branch]
(https://github.com/bartaz/impress.js/tree/master). But remember that the team will only accept code that fits the purpose of impress.js.
Guidelines:
* If proposing a feature, make sure to discuss that as an issue first.
* Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make.
* Execute `npm run lint && npm test` to make sure the tests pass and the code is consistent with the project standards.
Manual release steps
--------------------
* Bump version in `package.json`
* Bump version in `src/impress.js`
* Create commit with the message "Release version x.x.x"
* Create Github tag and release
* Publish on npm: `git fetch && npm publish ./`

View File

@@ -1,5 +0,0 @@
**Make sure these boxes are checked before submitting your issue, thank you!**
- [ ] I have read and complied with the [Issues Contributing Guidelines](https://github.com/impress/impress.js/blob/master/.github/CONTRIBUTING.md#issues).
- [ ] If am reporting a bug, I have a [simplified example](http://www.sscce.org/) on [Pastebin](https://pastebin.com/) or [JsFiddle](https://jsfiddle.net/) that reproduces the issue.
- [ ] I have used the [Search Tool](https://github.com/impress/impress.js/search) to make sure someone haven't already reported my issue or feature request.

View File

@@ -1,6 +0,0 @@
**Make sure these boxes are checked before submitting your Pull Request, thank you!**
- [ ] I have read and complied with the [Pull Request Contributing Guidelines](https://github.com/impress/impress.js/blob/master/CONTRIBUTING.md#pull-requests).
- [ ] I checked if an [an issue](https://github.com/impress/impress.js/issues) is necessary for my Pull Request and made sure it exists.
- [ ] I have created a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches).
- [ ] I have used the [Search Tool](https://github.com/impress/impress.js/search?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen&type=Issues) to make sure there are no open Pull Requests fixing the same thing.

View File

@@ -14,15 +14,19 @@ impress.js may not help you if you have nothing interesting to say ;)
HOW TO USE IT HOW TO USE IT
--------------- ---------------
[Use the source](index.html), Luke ;) ### Checking out and initializing the git repository
The [HTML source code](index.html) serves as a good example usage and contains comments explaning various features of impress.js. For more information about styling you can look into [CSS code](css/impress-demo.css) which shows how classes provided by impress.js can be used. Last but not least [JavaScript code of impress.js](js/impress.js) has some useful comments if you are interested in how everything works. Feel free to explore! git clone --recursive https://github.com/impress/impress.js.git
cd impress.js
If you want more straightforward reference documentation of all impress.js features and API you can find it in [DOCUMENTATION.md](DOCUMENTATION.md). Note: For a minimal checkout, omit the `--recursive` option. This will leave out extra plugins.
### Documentation
EXAMPLES AND OTHER LEARNING RESOURCES Reference documentation of core impress.js features and API you can find it in [DOCUMENTATION.md](DOCUMENTATION.md).
---------------------------------------
The [HTML source code](index.html) of the official [impress.js demo](http://impress.github.io/impress.js/) serves as a good example usage and contains comments explaning various features of impress.js. For more information about styling you can look into [CSS code](css/impress-demo.css) which shows how classes provided by impress.js can be used. Last but not least [JavaScript code of impress.js](js/impress.js) has some useful comments if you are interested in how everything works. Feel free to explore!
### Official demo ### Official demo
@@ -30,6 +34,8 @@ EXAMPLES AND OTHER LEARNING RESOURCES
### Examples and demos ### Examples and demos
The [Classic Slides](http://impress.github.io/impress.js/examples/classic-slides/) demo is targeted towards beginners, or can be used as a template for presentations that look like the traditional PowerPoint slide deck. Over time, it also grew into the example presentation that uses most of the features and addons available.
More examples and demos can be found on [Examples and demos wiki page](http://github.com/impress/impress.js/wiki/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. Feel free to add your own example presentations (or websites) there.
@@ -41,20 +47,48 @@ 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. 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.
You may want to check out the sibling project [Impressionist|https://github.com/henrikingo/impressionist]: a 3D GUI editor that can help you in creating impress.js presentations.
### Mailing list
You're welcome to ask impress.js related questions on the [impressionist-presentations](https://groups.google.com/forum/#!forum/impressionist-presentations) mailing list.
REPOSITORY STRUCTURE
--------------------
* [index.html](index.html): This is the official impress.js demo, showcasing all of the features of the original impress.js, as well as some new plugins as we add them.
* As already mentioned, this file is well commented and acts as the official tutorial.
* [examples/](examples/): Contains several demos showcasing additional features available.
* [Classic Slides](examples/classic-slides/index.html) is a simple demo that that you can use as template if you want to create very simple, rectangular, PowerPoint-like presentations.
* [src/](src/): The main file is [src/impress.js](src/impress.js). Additional functionality is implemented as plugins in [src/plugins/](src/plugins/).
* See [src/plugins/README.md](src/plugins/README.md) for information about the plugin API and how to write plugins.
* [test/](test/): Contains QUnit and Syn libraries that we use for writing tests, as well as some test coverage for core functionality. (Yes, more tests are much welcome.) Tests for plugins are in the directory of each plugin.
* [js/](js/): Contains [js/impress.js](js/impress.js), which contains a concatenation of the core `src/impress.js` and all the plugins. Traditionally this is the file that you'll link to in a browser. In fact both the demo and test files do exactly that.
* [css/](css/]: Contains a CSS file used by the demo. This file is **not required for using impress.js** in your own presentations. Impress.js creates the CSS it needs dynamically.
* [extras/](extras/) contains plugins that for various reasons aren't enabled by default. You have to explicitly add them with their own `script` element to use them.
* [build.js](build.js): Simple build file that creates `js/impress.js`. It also creates a minified version `impress.min.js`, but that one is not included in the github repository.
* [package.json](build.js): An NPM package specification. This was mainly added so you can easily install [buildify](https://www.npmjs.com/package/buildify) and run `node build.js`. Other than the build process, which is really just doing roughly `cat src/impress.js src/plugins/*/*.js > js/impress.js`, and testing, `impress.js` itself doesn't depend on Node or any NPM modules.
* [bower.json](bower.json): A Bower package file. We also don't depend on Bower, but provide this file if you want to use it.
WANT TO CONTRIBUTE? 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). For developers, once you've made changes to the code, you should run these commands for testing:
**Note:** The team has changed, so there will be many changes in the upcoming versions. npm run build
If you need informations about versions, check the [changelog](CHANGELOG.md). npm run test
npm run lint
Note that running `firefox qunit_test_runner.html` is usually more informative than running `karma` with `npm run test`. They both run the same tests.
More info about the [src/](src/) directory can be found in [src/plugins/README.md](src/plugins/README.md).
ABOUT THE NAME ABOUT THE NAME
---------------- ----------------
impress.js name in [courtesy of @skuzniak](http://twitter.com/skuzniak/status/143627215165333504). impress.js name is [courtesy of @skuzniak](http://twitter.com/skuzniak/status/143627215165333504).
It's an (un)fortunate coincidence that a Open/LibreOffice presentation tool is called Impress ;) It's an (un)fortunate coincidence that a Open/LibreOffice presentation tool is called Impress ;)
@@ -66,11 +100,21 @@ See the [Reference API](DOCUMENTATION.md)
BROWSER SUPPORT BROWSER SUPPORT
----------------- -----------------
This project supports only the major [evergreen](http://eisenbergeffect.bluespire.com/evergreen-browsers/) desktop browsers that have implemented: The design goal for impress.js has been to showcase awesome CSS3 features as found in modern browser versions. We also use some new DOM functionality, and specifically do not use jQuery or any other JavaScript libraries, nor our own functions, to support older browsers. In general, recent versions of Firefox and Chrome are known to work well. Reportedly IE now works too.
The typical use case for impress.js is to create presentations that you present from your own laptop, with a browser version you know works well. Some people also use impress.js successfully to embed animations or presentations in a web page, however, be aware that in this some of your visitors may not see the presentation correctly, or at all.
In particular, impress.js makes use of the following JS and CSS features:
* [DataSet API](http://caniuse.com/#search=dataset) * [DataSet API](http://caniuse.com/#search=dataset)
* [ClassList API](http://caniuse.com/#search=classlist) * [ClassList API](http://caniuse.com/#search=classlist)
* [CSS 3D Transforms](http://caniuse.com/#search=css%203d) * [CSS 3D Transforms](http://caniuse.com/#search=css%203d)
* [CSS Transitions](http://caniuse.com/#search=css%20transition) * [CSS Transitions](http://caniuse.com/#search=css%20transition)
Copyright 2011-2016 Bartek Szopka - Released under the MIT [License](LICENSE) COPYRIGHT AND LICENSE
---------------------
Copyright 2011-2016 Bartek Szopka
Copyright 2015-2017 Henrik Ingo
Released under the MIT [License](LICENSE)