Formatting

README.rst

@@ -47,7 +47,7 @@ Steps to script things up
         </resource>
 
 - create imsmanifest from list of files the user provides and put that in tmp folder
-- copy user's input files into `/res/` in the tmp folder
+- copy user's input files into ``/res/`` in the tmp folder
 - zip up the tmp folder to produce a scorm package.
 
 
@@ -57,29 +57,29 @@ 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).
+Create markdown file with slide source (test.md in this example).
 
-    Folder structure
+Folder structure
 
-    /source/test.md
-    /source/images/<image files to include>
+/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).
+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
+https://pandoc.org/MANUAL.html#producing-slide-shows-with-pandoc
 
-    ## Create HTML slides:
-    pandoc -t slidy --self-contained test.md -o test.html
+## 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
+(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)
+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]
 

setup.cfg

@@ -4,7 +4,7 @@
 
 [metadata]
 name = scorm_package
-description = Add a short description here!
+description = Convert a folder of HTML files into a SCORM package.
 author = Will Usher, Tommy Hutcheson
 author_email = [email protected]
 license = MIT