Skip to content

Commit 598eee1

Browse files
docs(readme): add installation, contributing, and licence section
Also made sure that is it removable in CI/CD pipelines so that they won't show up in those READMEs.
1 parent a9b7247 commit 598eee1

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@
7373
</badges-container>
7474
</div>
7575

76+
<toc-section data-why="So that we can remove it before publishing an image or npm package.">
77+
78+
# Slyde
79+
80+
- [Slyde](#slyde)
81+
- [What is Slyde?](#what-is-slyde)
82+
- [Features](#features)
83+
- [Installation](#installation)
84+
- [NPM package installation](#npm-package-installation)
85+
- [Docker image installation](#docker-image-installation)
86+
- [Building from source](#building-from-source)
87+
- [Contributing](#contributing)
88+
- [Licence](#licence)
89+
90+
</toc-section>
91+
7692
## What is Slyde?
7793

7894
Slyde is a program to create professional beautifully animated presentations from XML. It is fast and easy, even for non-technical people.
@@ -99,3 +115,57 @@ This would output the following fully animated presentation:
99115
- Rich plugin system extend Slyde in under a minute
100116
- Exports are offline-ready HTML files
101117
- Embed images in your presentation
118+
119+
## Installation
120+
121+
There are several ways to install Slyde: [installing an npm package](#npm-package-installation), [pull docker image](#docker-image-installation), or [building from source](#building-from-source).
122+
123+
### NPM package installation
124+
125+
To install slyde using [GitHub' NPM registry](https://npm.pkg.github.com/), run the following command:
126+
127+
```Shell
128+
npm install --global @tygo-van-den-hurk/slyde --registry=https://npm.pkg.github.com/
129+
```
130+
131+
Slyde is now installed in your path. You might need to restart your session.
132+
133+
### Docker image installation
134+
135+
To install slyde using [docker](http://docker.com), run the following command:
136+
137+
```Shell
138+
docker pull ghcr.io/tygo-van-den-hurk/slyde:latest
139+
```
140+
141+
To run Slyde, run the following command:
142+
143+
```Shell
144+
docker run --volume "$PWD:/src" --rm ghcr.io/tygo-van-den-hurk/slyde:latest compile /src/slyde.xml --output /src/slyde.html
145+
```
146+
147+
### Building from source
148+
149+
To build slyde from source, run the following commands:
150+
151+
```Shell
152+
git clone http://github.com/tygo-van-den-hurk/slyde slyde
153+
cd slyde
154+
npm ci
155+
npm run build
156+
npm install --global .
157+
```
158+
159+
Slyde is now installed in your path. You might need to restart your session.
160+
161+
<contributing-section data-why="So that we can remove it before publishing an image or npm package.">
162+
163+
## Contributing
164+
165+
If you would like to make Slyde better, see the [contributing guidelines](./CONTRIBUTING.md).
166+
167+
</contributing-section>
168+
169+
## Licence
170+
171+
All files in this repository fall under a [licence](./LICENSE).

0 commit comments

Comments
 (0)