bmstu-mt-wp/README.md

76 lines
3.4 KiB
Markdown
Raw Normal View History

2020-02-05 20:41:52 +03:00
# Shower Presentation Template
[![Test status](https://github.com/shower/shower/workflows/Test/badge.svg)](https://github.com/shower/shower/actions/workflows/test.yml)
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
2020-04-17 22:21:36 +03:00
1. Built on HTML, CSS and vanilla JavaScript.
2. Works in all modern browsers.
3. Themes are separated from engine.
4. Fully keyboard accessible.
5. Printable to PDF.
2015-12-13 06:09:18 +03:00
2020-04-17 22:21:36 +03:00
[See it in action](https://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.
2015-12-13 06:54:34 +03:00
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
2020-04-17 22:21:36 +03:00
1. Download and unzip [shower.zip](http://shwr.me/shower.zip) template archive.
2021-02-24 12:47:33 +03:00
2. Open `index.html` in any text editor and start creating your presentation.
2015-12-13 06:09:18 +03:00
2020-04-17 22:21:36 +03:00
## Quick Start via CLI
2018-05-18 13:27:37 +03:00
2020-04-17 22:21:36 +03:00
Youll need [Node.js](https://nodejs.org/) installed on your computer.
2018-05-18 13:27:37 +03:00
2020-04-17 22:21:36 +03:00
1. Install Shower CLI utility: `npm install -g @shower/cli`.
2. Create your presentation: `shower create`.
2018-05-18 13:27:37 +03:00
2020-04-17 22:21:36 +03:00
Read more on [shower/cli](https://github.com/shower/cli/) page.
2018-05-18 13:27:37 +03:00
2020-04-17 22:21:36 +03:00
## Quick Start with Hosting
2015-12-13 06:09:18 +03:00
2020-04-17 22:21:36 +03:00
Youll need [Node.js](https://nodejs.org/) installed on your computer.
2019-05-16 09:24:19 +03:00
2020-04-17 22:21:36 +03:00
1. Copy this repository to your account via GitHub.
1. Open [import page](https://github.com/new/import).
2. Use `https://github.com/shower/shower` for the repository URL
3. Use your presentation name.
4. Clone the resulted repository to your computer.
2. Install dependencies `npm install` and start a local server `npm start`.
3. Start editing your slides with live-reload.
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
2020-04-17 22:21:36 +03:00
Youll find your presentation in `prepared` folder. You can also run `npm run archive` to get the same files in `presentation.zip`.
2016-04-03 21:03:55 +03:00
2020-04-17 22:21:36 +03:00
Publish your presentation online by running:
2015-12-13 06:09:18 +03:00
2020-04-17 22:21:36 +03:00
npm run publish
2019-03-18 00:13:40 +03:00
2020-04-17 22:21:36 +03:00
Youll have your slides published to `https://USER.github.io/REPO/`.
2019-03-18 00:13:40 +03:00
2020-04-17 22:21:36 +03:00
## Deploy to Netlify
2019-03-18 00:13:40 +03:00
2020-04-17 22:21:36 +03:00
By clicking the button below you can fork this repo and deploy it to Netlify.
2019-03-18 00:13:40 +03:00
2020-04-17 22:21:36 +03:00
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/shower/shower)
2015-12-13 06:09:18 +03:00
2020-04-17 22:21:36 +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 an easy way to create and share Shower presentation without the need to install anything locally.
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
2020-04-17 22:21:36 +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), [zloylos](https://github.com/zloylos), [shvaikalesh](https://github.com/shvaikalesh).
2015-12-13 06:09:18 +03:00
---
2015-12-13 06:43:28 +03:00
Licensed under [MIT License](LICENSE.md).