From 976b954e3c95482ff94714d98ed5360f00b88142 Mon Sep 17 00:00:00 2001 From: Will Usher Date: Wed, 19 May 2021 23:59:18 +0200 Subject: [PATCH] Moved content from other readme --- README.md | 28 ---------------------------- README.rst | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 28 deletions(-) delete mode 100755 README.md diff --git a/README.md b/README.md deleted file mode 100755 index 22dc16b..0000000 --- a/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# Notes on running the scorm.py script which produces a SCORM package - -#Prerequisites - # Notes on producing slides for SCORM package - - Create markdown file with slide source (test.md in this example). - - Folder structure - - /source/test.md - /source/images/ - - Use pandoc to compile self-contained HTML slides with the slidy framework (requires connection to web to get slidy CSS). - - https://pandoc.org/MANUAL.html#producing-slide-shows-with-pandoc - - ## Create HTML slides: - pandoc -t slidy --self-contained test.md -o test.html - - (can also create PDF slides - requires pdfLaTeX) - pandoc -t beamer test.md -V theme:Warsaw -o test.pdf - -#Running the Python script - You just need to provide two arguments with the python script: - The first argument is the name you want to give your scorm package. - The second argument is the name of your created self-contained html file (created in the Prerequisites) - -#For help run -h or --help "python scorm.py -h" otherwise contact thomas.hutcheson@moneysupermarket.com diff --git a/README.rst b/README.rst index 5ae4c9d..937a120 100644 --- a/README.rst +++ b/README.rst @@ -51,6 +51,39 @@ Steps to script things up - zip up the tmp folder to produce a scorm package. +Notes on running the scorm.py script which produces a SCORM package +------------------------------------------------------------------- + +Notes on producing slides for SCORM package +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Create markdown file with slide source (test.md in this example). + + Folder structure + + /source/test.md + /source/images/ + + Use pandoc to compile self-contained HTML slides with the slidy framework (requires connection to web to get slidy CSS). + + https://pandoc.org/MANUAL.html#producing-slide-shows-with-pandoc + + ## Create HTML slides: + pandoc -t slidy --self-contained test.md -o test.html + + (can also create PDF slides - requires pdfLaTeX) + pandoc -t beamer test.md -V theme:Warsaw -o test.pdf + +#Running the Python script +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + You just need to provide two arguments with the python script: + The first argument is the name you want to give your scorm package. + The second argument is the name of your created self-contained html file (created in the Prerequisites) + +#For help run -h or --help "python scorm.py -h" otherwise contact thomas.hutcheson@moneysupermarket.com + + .. _pyscaffold-notes: Note