From 8f05879221abb0c81290ee2a8809f047ad8b6fd6 Mon Sep 17 00:00:00 2001 From: an Date: Sun, 5 Nov 2017 22:34:58 +0100 Subject: [PATCH] README.md --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 07f335e..02e4324 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ # 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 default +``` + +This creates an empty presentation with the default theme in the current dir. +After that, edit `presentation.md`.