Skip to content

Commit a561848

Browse files
Add build instructions in readme
1 parent a3ad37d commit a561848

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,45 @@
22
Emmanuel Bernard
33

44
Git repository containing the command line nuts presentation and samples.
5+
6+
== How to build the presentation
7+
8+
The presentation is based on the Asciidoctor reveal.js backend.
9+
10+
=== Setup
11+
12+
You need Ruby (tested on 2.1), and make sure you have Bundler and Rake installed
13+
14+
[source, language="bash"]
15+
--
16+
gem install bundler
17+
gem install rake
18+
--
19+
20+
Then install the necessary gems
21+
22+
[source, language="bash"]
23+
--
24+
rake setup
25+
--
26+
27+
=== Generating the presentation
28+
29+
[source, language="bash"]
30+
--
31+
rake build_reveal
32+
--
33+
34+
=== Generating the presentation on every change
35+
36+
37+
[source, language="bash"]
38+
--
39+
rake guard
40+
--
41+
42+
Also install the live reload plugin from Chrome and activate it when displaying the presentation.
43+
44+
== License
45+
46+
Release under the WTFPL 2.0 available in LICENSE.txt

0 commit comments

Comments
 (0)