Update README.MD

nap-writing-print/README.MD

@@ -20,7 +20,7 @@ The full process to go from receiveing a NAPLAN results data file is:
 1. invoke nap-writing-print with the following command
 > ./nap-writing-print
 
-The nap-writing-print tool will then run and create individual pdf files for each writing response that it finds 
+The nap-writing-print tool will then run and create individual html files for each writing response that it finds 
 in the provided writing_extract.csv file.
 
 When the tool runs it creates two folder strucures in its /out directory
@@ -39,10 +39,13 @@ in each of the folders you will find the following sub-folder strucure
 
 /script
 
-The files are named with a prefix of the student participation code, followed by the anonymous id given 
+The files are named with a prefix of the state identifier and the student participation code, followed by the anonymous id given 
 to that student's script. The participation prefix is to allow users to ignore
 scripts or non-scripts from students who did not complete the writing test.
 
+writing script files end with the suffix script
+audit files end with the suffix audit
+
 The files have the same name, for cross validation, in each folder
 
 Files in the /script directory contain
@@ -53,24 +56,19 @@ the meta-data associated with the student's script; such as PSI, Local identifie
 
 This means scripts can be distributed independently, but manually reconciled if needed.
 
-As the pdf outout is constructed entirely from the contents of the input file, for safety at the end of a run a timestamped 
-folder is created in the /backup directory of the nap-writing-print folder so that the same pdfs can be 
+As the html outout is constructed entirely from the contents of the input file, for safety at the end of a run a timestamped 
+folder is created in the /backup directory of the nap-writing-print folder so that the same html files can be 
 generated at any time in the future even if the working .csv file has been over-written.
 
-The pdf files are all sized as A4, and are currently only created in black and white, the printing tool
-does not maintain any text colouring added by the user.
-
-The output file does maintain the paragraphing of the original input from the user, but does not maintain formatting 
-such as bold, italics or sub/superscripting.
-
-All input will be rendered as text icluding the best textual approximation of extended chars such as emojis.
+The output file maintains the paragraphing of the original input from the user, bold text, underlined text, italic text, and ordered and unordered lists as available in the online naplan editor component.
 
 It goes without saying that this tool will generate a lot of files, so is best run on 64-bit environments where constraints
 on number of files in a directory or folder are not an issue if large input files are being processed.
 
 It is advised for best performance to run on a machine with an  SSD hard disk.
 
-Current performance on a i5 macbook creates 200k pdfs in around 2 minutes.
+Current performance on a i5 macbook creates 200,000 html files (4 files for each of 50k students) in around 1 minute.
+