diff --git a/README.md b/README.md index a44a4bf..e724000 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Teaching-Boilerplate +# GX-Teaching -## Prerequisites : +## Prerequisites -Make sure you have docker installed +Make sure you have Docker installed. -## Usage +## Writing content ### Create your directory tree @@ -18,33 +18,43 @@ Make sure you have docker installed |- ... ``` -### Write content for docs +### Content for docs +FIXME: tree structure -### Write content for slides +FIXME: autoslide feature +### Content for slides -### Watch mode +FIXME: tree structure + +## Watch mode This mode allows you the result on-the-fly as you makea changes in the content. To use watch mode, type: - make watch + gx-teaching -a watch To use watch mode for slides only type: - make watch-slides + gx-teaching -a watch-slides To use watch mode for docs only type: - make watch-docs + gx-teaching -a watch-docs -### Build mode +## Build mode This mode builds final content for delivery (website, PDF files) +### Building HTML + To use build mode: - make build + gx-teaching build + +### Building PDF + +