diff options
| -rw-r--r-- | README.md | 34 | ||||
| -rw-r--r-- | README.rst | 25 |
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 @@ | |||
| 1 | My Convention Presentations | ||
| 2 | =========================== | ||
| 3 | |||
| 4 | If you're interested in my presentations, you can go look at them here: | ||
| 5 | https://krotscheck.github.io/presentations/ | ||
| 6 | |||
| 7 | |||
| 8 | Building your own presentations | ||
| 9 | ------------------------------- | ||
| 10 | |||
| 11 | If you would like to use this repository as a base from which to build your | ||
| 12 | own presentation website, you can clone the ``starter`` branch and work from | ||
| 13 | there. First, you will need node and npm. | ||
| 14 | |||
| 15 | // On ubuntu: | ||
| 16 | apt-get install nodejs nodejs-legacy npm | ||
| 17 | |||
| 18 | |||
| 19 | The 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 @@ | |||
| 1 | My website, blog posts and conference talks | ||
| 2 | =========================================== | ||
| 3 | |||
| 4 | If you're interested in my presentations, you can go look at them here: | ||
| 5 | http://inaugust.com/talks | ||
| 6 | |||
| 7 | Building | ||
| 8 | -------- | ||
| 9 | |||
| 10 | First, you will need node and npm. | ||
| 11 | :: | ||
| 12 | |||
| 13 | apt-get install nodejs nodejs-legacy npm | ||
| 14 | |||
| 15 | The 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 | ||
