mrtoth
/
test-tutorial-framework
mirror of https://github.com/avatao-content/test-tutorial-framework
1
0
Fork 0
Code Issues Releases Wiki Activity

Start rewriting README

This commit is contained in:
Kristóf Tóth 2018-03-30 22:14:11 +02:00
parent cf316fcc7b
commit 818dfc672f
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View 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 ...*