From b8bcda134c31808dcadc490446c1f383ec6d2099 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20T=C3=B3th?= Date: Fri, 30 Mar 2018 22:37:36 +0200 Subject: [PATCH] Start rewriting README.md --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1efe5ef..79963d9 100644 --- a/README.md +++ b/README.md @@ -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. - -## Creating child images - -Documentation in progress... +## The framework +*... in progress ...*