bmstu-mt-wp/README.md

80 lines
3.7 KiB
Markdown
Raw Normal View History

2016-08-12 00:47:42 +03:00
# Shower Presentation Template [![Build Status](https://travis-ci.org/shower/shower.svg?branch=master)](https://travis-ci.org/shower/shower)
2015-12-13 06:09:18 +03:00
2015-12-24 18:25:34 +03:00
<img src="pictures/logo.png" width="250" alt="Shower logo">
2015-12-24 16:40:06 +03:00
2015-12-13 06:43:28 +03:00
> Shower ['ʃəuə] noun. A person or thing that shows.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
1. Built on HTML, CSS and vanilla JavaScript
2. Works in all modern browsers
3. Themes are separated from engine
2018-06-16 01:54:30 +03:00
4. Fully keyboard accessible
5. Printable to PDF
2015-12-13 06:09:18 +03:00
2015-12-13 06:54:34 +03:00
[See it in action](http://shwr.me/). Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/core/) with plugins.
Follow [@shower_me](https://twitter.com/shower_me) for support and updates, [file an issue](https://github.com/shower/shower/issues/new) if you have any.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Quick Start
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
1. Download and unzip [template archive](http://shwr.me/shower.zip)
2015-12-13 06:54:34 +03:00
2. Open `index.html` and start creating your presentation
2015-12-13 06:09:18 +03:00
2018-05-18 13:27:37 +03:00
## Deploy to Netlify
By clicking the button below you can fork this repo and deploy it to Netlify.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/shower/shower)
2018-06-16 01:54:30 +03:00
By doing this you would get a GitHub repo linked with Netlify in a way any change to the repo would trigger a shower rebuild and deploy to Netlify servers, which allows for a really easy way to create and share Shower presentation without the need to install anything locally.
2018-05-18 13:27:37 +03:00
2015-12-13 06:43:28 +03:00
## Advanced
2015-12-13 06:09:18 +03:00
2019-03-18 00:13:40 +03:00
### Get your own Shower
2019-05-16 09:24:19 +03:00
2019-03-18 00:13:40 +03:00
1. Copy Shower in your account via [GitHub](#copy-via-github) or via [CLI](#copy-via-cli)
2. Install dependencies `npm install` and start it `npm start`.
2015-12-13 06:09:18 +03:00
2016-04-03 21:03:55 +03:00
Once youre done you can build a clean copy of your slides:
2018-08-24 11:48:59 +03:00
npm run prepare
2016-04-03 21:03:55 +03:00
And youll find your presentation in `prepared` folder with only needed files in it. You can also run `npm run archive` to get the same files in `archive.zip`. But theres more! You can easily publish your presentation online by running:
2018-08-24 11:48:59 +03:00
npm run publish
2016-04-03 21:03:55 +03:00
2017-09-19 11:31:53 +03:00
And youll have your slides published to `http://USER.github.io/REPO/`.
2015-12-13 06:09:18 +03:00
2019-03-18 00:13:40 +03:00
#### Copy via GitHub
2019-05-16 09:24:19 +03:00
1. Open [import page](https://github.com/new/import).
2. For the repository URL use `https://github.com/shower/shower`.
3. For the name use any name you want, your presentation name would be the best.
4. Clone the resulted repository to your computer.
2019-03-18 00:13:40 +03:00
#### Copy via CLI
1. Сlone this repository `git clone --depth=1 git@github.com:shower/shower.git`, (`--depth=1` will make it way faster).
2. [Create](https://github.com/new) a new blank repository and copy its cloning address `git@github.com:USER/REPO.git`.
3. Change remote of your local clone to the one youve just copied `git remote set-url origin git@github.com:USER/REPO.git`.
4. Push your local clone to GitHub `git push -u origin master`.
2015-12-13 06:43:28 +03:00
## Usage Examples
2015-12-13 06:09:18 +03:00
2019-01-19 16:48:28 +03:00
- [Semantic for cynics](https://pepelsbey.net/pres/semantics/en/)
2017-09-19 11:32:06 +03:00
- [Inhuman UI](https://pepelsbey.net/pres/inhuman-ui/)
- [My Vanilla CSS](https://pepelsbey.net/pres/vanilla-css/)
- [Im in IoT](https://pepelsbey.net/pres/im-in-iot/)
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Browser Support
2015-12-13 06:09:18 +03:00
2018-02-07 06:24:27 +03:00
Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.
2015-12-13 06:09:18 +03:00
## Contributing
2015-12-13 06:43:28 +03:00
Youre always welcome to contribute. Fork project, make changes and send it as pull request. But its better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](CONTRIBUTING.md) for more details.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
Main contributors in historical order: [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), [zloylos](https://github.com/zloylos).
2015-12-13 06:09:18 +03:00
---
2015-12-13 06:43:28 +03:00
Licensed under [MIT License](LICENSE.md).