Skip to content

Commit

Permalink
Moved content from other readme
Browse files Browse the repository at this point in the history
  • Loading branch information
willu47 committed May 19, 2021
1 parent 5aeb9b4 commit 976b954
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 28 deletions.
28 changes: 0 additions & 28 deletions README.md

This file was deleted.

33 changes: 33 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/<image files to include>

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 [email protected]


.. _pyscaffold-notes:

Note
Expand Down

0 comments on commit 976b954

Please sign in to comment.