Start rewriting README.md

This commit is contained in:
Kristóf Tóth 2018-03-30 22:37:36 +02:00
parent d5f11f9a08
commit b8bcda134c

View File

@ -1,16 +1,12 @@
Tutorial Framework # baseimage-tutorial-framework
==================
## Building and running with magic starter This is the beating heart of TFW the Docker baseimage consisting of the backend internals of the framework.
Execute the `tfw_magic_start.sh` script and it will automagically run a backend instance in Docker and serve the Angular frontend locally. All tutorial-framework challenges are child images of this one: their `Dockerfile`s all begin with `FROM avatao/tutorial-framework`.
This requires the `test-tutorial-framework` (Docker image `FROM baseimage-tutorial-framework`) and `frontend-tutorial-framework` repositories to have a common parent folder. This document explains the general concepts of TFW and should be the first thing you read before getting started with development.
## Building with Docker For more on building and running you should consult the `test-tutorial-framework` repo.
Simply issue `docker build -t baseimage-tutorial-framework .` in the project root. ## The framework
*... in progress ...*
## Creating child images
Documentation in progress...