README.md
This commit is contained in:
parent
ab510438ab
commit
8f05879221
28
README.md
28
README.md
|
@ -1,6 +1,30 @@
|
||||||
# rmsh
|
# rmsh
|
||||||
|
|
||||||
Remark Shell
|
## Remark Shell
|
||||||
|
|
||||||
A tool for creating and handling remark.js based presentations.
|
Create and work with presentations using remark.js.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
* https://remarkjs.com/#1
|
||||||
|
|
||||||
|
```
|
||||||
|
cd rmsh/share/js && wget https://remarkjs.com/downloads/remark-latest.min.js
|
||||||
|
```
|
||||||
|
|
||||||
|
* http://sass-lang.com/
|
||||||
|
|
||||||
|
For Debian-based distributions:
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo apt-get install ruby-sass
|
||||||
|
```
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
```
|
||||||
|
rmsh create <my-presentation> default
|
||||||
|
```
|
||||||
|
|
||||||
|
This creates an empty presentation with the default theme in the current dir.
|
||||||
|
After that, edit `presentation.md`.
|
||||||
|
|
Loading…
Reference in New Issue