Update documentation

- Rewrite README.md
- Modify build-pdf.sh script to concatenate template and README.md
- Add userguide recipe to Makefile
This commit is contained in:
Matthew Northcott 2023-04-24 16:14:08 +12:00
parent d39e7da6f1
commit 535ade8a63
8 changed files with 254 additions and 331 deletions

29
docs/img/flowchart.md Normal file
View file

@ -0,0 +1,29 @@
flowchart TB
access[Access site]
activation[Activation]
valid[Valid key?]
remaining[Activations remaining?]
checkout[Stripe Checkout]
questionnaire[Questionnaire]
activate[Activate key]
results[Show table of results]
error[Error]
physical[Ordered physical copy?]
receive[Receive physical copy in mail]
done[Done]
access-->activation
activation-->checkout
checkout-->activation
activation-->valid
valid--"No"-->error
valid--"Yes"-->remaining
remaining--"Yes"-->questionnaire
remaining--"No"-->results
error-->activation
questionnaire-->activate
activate-->results
results-->physical
physical--"No"-->done
physical--"Yes"-->receive
receive-->done

BIN
docs/img/flowchart.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB