summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2015-08-01 03:26:45 +1000
committerMonty Taylor <mordred@inaugust.com>2015-08-01 03:26:45 +1000
commit816c90235ed3393b72fc2344457a105971049b5b (patch)
tree3aa9f0fa4858a60dcb98ecda2fe271a2785930ae
parent22ab0f1a87a61a84dc78721ecbdde43ec2b1c556 (diff)
Updated README
-rw-r--r--README.md34
-rw-r--r--README.rst25
2 files changed, 25 insertions, 34 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 62b6c6a..0000000
--- a/README.md
+++ /dev/null
@@ -1,34 +0,0 @@
1My Convention Presentations
2===========================
3
4If you're interested in my presentations, you can go look at them here:
5https://krotscheck.github.io/presentations/
6
7
8Building your own presentations
9-------------------------------
10
11If you would like to use this repository as a base from which to build your
12own presentation website, you can clone the ``starter`` branch and work from
13there. First, you will need node and npm.
14
15 // On ubuntu:
16 apt-get install nodejs nodejs-legacy npm
17
18
19The following commands will get you started:
20
21 // This will install miscellaneous runtime dependencies.
22 npm install
23
24 // This will start a VERY basic presentation wizard. To modify the
25 // output, make changes in ./src/template/index.hbs
26 npm run new
27
28 // This will create a local webhost, serving all of your presentations.
29 // It will autodetect changes and refresh any applicable pages.
30 npm run serve
31
32 // This will construct your current presentations, and push them to
33 // gh-pages.
34 npm run release
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e7d40b6
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,25 @@
1My website, blog posts and conference talks
2===========================================
3
4If you're interested in my presentations, you can go look at them here:
5http://inaugust.com/talks
6
7Building
8--------
9
10First, you will need node and npm.
11::
12
13 apt-get install nodejs nodejs-legacy npm
14
15The following commands will get you started:
16::
17 # This will install miscellaneous runtime dependencies.
18 npm install
19
20 # This will create a local webhost, serving all of your presentations.
21 # It will autodetect changes and refresh any applicable pages.
22 npm run serve
23
24 # This will construct your current presentations, and rsync them
25 npm run release