mirror of
				https://github.com/avatao-content/test-tutorial-framework
				synced 2025-11-04 05:12:54 +00:00 
			
		
		
		
	Start rewriting README
This commit is contained in:
		
							
								
								
									
										22
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,22 @@
 | 
			
		||||
# tutorial-framework test
 | 
			
		||||
 | 
			
		||||
This is an example playground project built via TFW.
 | 
			
		||||
It is a good starting point to build your own challenges from and will host automated tests in the future.
 | 
			
		||||
 | 
			
		||||
It also gives home to several useful scripts in the `hack` folder to speed up development.
 | 
			
		||||
 | 
			
		||||
## Getting started
 | 
			
		||||
 | 
			
		||||
TFW consists of 3 repositories:
 | 
			
		||||
- `baseimage-tutorial-framework` – Docker baseimage
 | 
			
		||||
- `frontend-tutorial-framework` – Angular frontend
 | 
			
		||||
- `test-tutorial-framework` (this repo)
 | 
			
		||||
 | 
			
		||||
See the documentation of each in their `README.md` files.
 | 
			
		||||
 | 
			
		||||
Getting started with creating challenges using the framework – *setting up a development environment, building, running and such* – is documented here.
 | 
			
		||||
 | 
			
		||||
To learn the stuff you need to know about TFW in order to get started you should consult the `baseimage-tutorial-framework` repo first.
 | 
			
		||||
 | 
			
		||||
## Setting up a development environment
 | 
			
		||||
*... in progress ...*
 | 
			
		||||
		Reference in New Issue
	
	Block a user