Started drafting documentation
This commit is contained in:
		
							
								
								
									
										41
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										41
									
								
								README.md
									
									
									
									
									
								
							@@ -1,3 +1,40 @@
 | 
			
		||||
# ska-referee-test
 | 
			
		||||
# SKA Referee Test App
 | 
			
		||||
 | 
			
		||||
An on-line version of a referee test for the Scottish Korfball Association.
 | 
			
		||||
## About
 | 
			
		||||
 | 
			
		||||
```A web app that digitises the theory exam for the Scottish Korfball Association referee qualification```
 | 
			
		||||
 | 
			
		||||
This web app provides an on-line platform through which to administer and take the SKA Refereeing theory exam.
 | 
			
		||||
The app includes a digital client to take the exam for candidates, as well as an admin console from which to manage tests, view results, and update questions.
 | 
			
		||||
The exam client is made with accessibility in mind, and has been designed to be adaptable to dyslexia and other learning needs or cognitive needs.
 | 
			
		||||
 | 
			
		||||
## Set Up and Installation
 | 
			
		||||
 | 
			
		||||
The clien is designed to work on a server.
 | 
			
		||||
 | 
			
		||||
### Pre-Requisites
 | 
			
		||||
 | 
			
		||||
Server
 | 
			
		||||
Docker
 | 
			
		||||
Docker-Compose
 | 
			
		||||
Git
 | 
			
		||||
 | 
			
		||||
### Installation
 | 
			
		||||
 | 
			
		||||
#### Preliminary Set-Up: Clone repos and Configure Values
 | 
			
		||||
 | 
			
		||||
#### Set Up Web Server
 | 
			
		||||
 | 
			
		||||
#### Incorporate SSL
 | 
			
		||||
 | 
			
		||||
#### Set Up Auto-Renew
 | 
			
		||||
 | 
			
		||||
### Alterations
 | 
			
		||||
 | 
			
		||||
## Use
 | 
			
		||||
 | 
			
		||||
## Compatibility
 | 
			
		||||
 | 
			
		||||
### iOS Limitations
 | 
			
		||||
 | 
			
		||||
### Fonts
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user