summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15b2640
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
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. The following commands will get you started:
14
15 // This will install miscellaneous runtime dependencies.
16 npm install
17
18 // This will start a VERY basic presentation wizard. To modify the
19 // output, make changes in ./src/template/index.hbs
20 npm run new
21
22 // This will create a local webhost, serving all of your presentations.
23 // It will autodetect changes and refresh any applicable pages.
24 npm run serve
25
26 // This will construct your current presentations, and push them to
27 // gh-pages.
28 npm run release