summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 3ddfe54..862bf70 100644
--- a/README.rst
+++ b/README.rst
@@ -7,19 +7,22 @@ http://inaugust.com/talks
7Building 7Building
8-------- 8--------
9 9
10First, you will need node and npm. 10First, you will need `yarn`_.
11::
12
13 apt-get install nodejs nodejs-legacy npm
14 11
15The following commands will get you started: 12The following commands will get you started:
16:: 13::
17 # This will install miscellaneous runtime dependencies. 14 # This will install miscellaneous runtime dependencies.
18 npm install 15 yarn install
19 16
20 # This will create a local webhost, serving all of your presentations. 17 # This will create a local webhost, serving all of your presentations.
21 # It will autodetect changes and refresh any applicable pages. 18 # It will autodetect changes and refresh any applicable pages.
22 npm start 19 yarn start
20
21 # This will build the content in the ``dist`` directory
22 yarn run package
23 23
24 # This will construct your current presentations, and rsync them 24 # This will construct your current presentations, and rsync them
25 npm run release 25 yarn run release
26
27
28.. _yarn: https://yarnpkg.com/en/docs/install