You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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,58 @@ This would output the following fully animated presentation:
99
115
- Rich plugin system extend Slyde in under a minute
100
116
- Exports are offline-ready HTML files
101
117
- 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
+
There are 2 ways to install Slyde using [npm](https://www.npmjs.com/). First of all using the repository syntax:
126
+
127
+
```Shell
128
+
npm install github:tygo-van-den-hurk/slyde
129
+
```
130
+
131
+
or using the `--registry` parameter to install slyde using [GitHub' NPM registry](https://npm.pkg.github.com/):
This is however not recommended even if you chose to install `--global` as this is very system dependent. The previous options are recommended for almost all use cases.
161
+
162
+
<contributing-sectiondata-why="So that we can remove it before publishing an image or npm package.">
163
+
164
+
## Contributing
165
+
166
+
If you would like to make Slyde better, see the [contributing guidelines](./CONTRIBUTING.md).
167
+
168
+
</contributing-section>
169
+
170
+
## Licence
171
+
172
+
All files in this repository fall under a [licence](./LICENSE).
0 commit comments