Uppercase’s back
This commit is contained in:
Vadim Makeev
parent
df956b819b
commit
15c9cdcb54
|
|
@ -0,0 +1,34 @@
|
|||
# Contributing to Shower
|
||||
|
||||
You’re always welcome to contibute! There are seven repositories in Shower project:
|
||||
|
||||
- [Core](https://github.com/shower/core) of Shower
|
||||
- [Shower](https://github.com/shower/template) template
|
||||
- [Ribbon](https://github.com/shower/ribbon) theme for Shower
|
||||
- [Bright](https://github.com/shower/bright) theme for Shower
|
||||
- [Jekyller](https://github.com/shower/jekyller) generator for Shower
|
||||
- [Sho.io](https://github.com/shower/sho.io) online service
|
||||
- [Shwr.me](https://github.com/shower/sho.io) service project
|
||||
|
||||
The most important part of the project is the [Core](https://github.com/shower/core) repository, containing [shower.js](https://github.com/shower/core/blob/master/shower.js) file.
|
||||
|
||||
## Issues
|
||||
|
||||
Before contributing to Shower, please read through [Issues](https://github.com/shower/shower/issues) to see open bugs and feature requests. If you have any feature to add to Shower or found a bug and want to fix it, please make sure you file an issue first.
|
||||
|
||||
## Process
|
||||
|
||||
To contribute to Shower fork needed repository and start making changes. Don’t forget to add upstream link to original repository and keep your fork updated. Once you finished, send pull request back to original repository and supply clear description or link to existing issue.
|
||||
|
||||
## Code style
|
||||
|
||||
Please keep existing code style while contributing to Shower and be ready for code review by Shower maintainers. It’s strongly recommended to install [EditorConfig](http://editorconfig.org) extension to your editor and validate your JavaScript changes using [JSHint](http://jshint.com/).
|
||||
|
||||
By historical reasons, Shower project is using tabs instead of spaces for code indentation. It’s not a big deal to keep this rule while contributing using you code editor options, even if your code style is 13.4 spaces.
|
||||
|
||||
## Language
|
||||
|
||||
English is the main language for Shower project. All discussions and commit messages should be in English, no matter if it’s good or bad. The second language of Shower is Russian. Offical Shower themes are always compatible with Cyrillic and Russian typography. All documentation to Shower is always localized to Russian.
|
||||
|
||||
---
|
||||
If you have any questions, please ask [@shower_me](http://twitter.com/shower_me/) or file an [issue](https://github.com/shower/shower/issues/new).
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
# The MIT License
|
||||
|
||||
Copyright © 2010–2014 Vadim Makeev, http://pepelsbey.net/
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
---
|
||||
|
||||
# Лицензия MIT
|
||||
|
||||
Copyright © 2010–2014 Вадим Макеев, http://pepelsbey.net/
|
||||
|
||||
Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:
|
||||
|
||||
Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.
|
||||
|
||||
ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
# Shower HTML presentation engine
|
||||
|
||||
Follow [@shower_me](https://twitter.com/shower_me) for support and updates.
|
||||
|
||||
To see Shower in action:
|
||||
|
||||
- Open [shwr.me](http://shwr.me/)
|
||||
- Click any slide to enter presentation mode
|
||||
- Use arrow keys or presenter remote to navigate
|
||||
- Press `Esc` to exit presentation mode
|
||||
|
||||
See [Wiki](https://github.com/shower/shower/wiki) for more information about how to use Shower.
|
||||
|
||||
## Using Shower
|
||||
|
||||
There are two ways of making presentation using Shower: you can just download an archive with all you need or you can install needed Shower modules using [npm](https://www.npmjs.org) or [bower](http://bower.io).
|
||||
|
||||
### Simple Way
|
||||
|
||||
In a simple way you just download the latest Shower version with built-in themes and use it.
|
||||
|
||||
1. Download and unarchive [shower.zip](http://shwr.me/shower.zip)
|
||||
2. Open `index.html` in any code or text editor, edit your slides in HTML
|
||||
3. Use `pictures` folder for pictures used in presentation
|
||||
4. Once finished, open `index.html` in a browser, enter full screen and start presenting
|
||||
|
||||
### Advanced Way
|
||||
|
||||
Advanced way allows you to manually install needed Shower packages and requires [Node.js](http://nodejs.org/) installed together with package managment system: `npm` or `bower`.
|
||||
|
||||
1. Run `npm install shower-core shower-ribbon`
|
||||
2. Link core and theme files in `node_modules` folder to your presentation file
|
||||
3. You probably know what to do next, it’s an advanced way
|
||||
|
||||
**Note:** you can use `bower` instead of `npm` or `shower-bright` instead of `shower-ribbon` in command above to install Shower using Bower or get Bright theme.
|
||||
|
||||
## Usage examples
|
||||
|
||||
- [Clear and Sharp](http://pepelsbey.net/pres/clear-and-sharp/)
|
||||
- [CSS Management](http://pepelsbey.net/pres/knife-train/)
|
||||
- [Push it!](http://pepelsbey.net/pres/push-it/)
|
||||
- [Pre-fixes](http://pepelsbey.net/pres/pre-fixes/)
|
||||
- [Web In Curves](http://pepelsbey.net/pres/web-in-curves/)
|
||||
- [Sense Coding](http://pepelsbey.net/pres/sense-coding/)
|
||||
|
||||
## Browser support
|
||||
|
||||
Latest stable versions of Chrome, Internet Explorer, Firefox, Opera and Safari are supported.
|
||||
|
||||
## Contributing
|
||||
|
||||
You’re always welcome to contibute. Fork project, make changes and send it as pull request. But it’s better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](https://github.com/shower/shower/blob/master/Contributing.md) for more details.
|
||||
|
||||
Main contributors: [pepelsbey](https://github.com/pepelsbey), [jahson](https://github.com/jahson), [miripiruni](https://github.com/miripiruni), [kizu](https://github.com/kizu), [artpolikarpov](https://github.com/artpolikarpov), [tonyganch](https://github.com/tonyganch).
|
||||
|
||||
---
|
||||
Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](https://github.com/shower/shower/wiki/MIT-License) for details.
|
||||
Loading…
Reference in New Issue