From dfb3933ebac278dee1906dd09a0fe816f0da01ca Mon Sep 17 00:00:00 2001 From: Michele Carignani <michele.carignani@etsi.org> Date: Tue, 13 Apr 2021 18:46:54 +0200 Subject: [PATCH] Improve docs --- Readme.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index cadaedd..7002a36 100644 --- a/Readme.md +++ b/Readme.md @@ -2,13 +2,15 @@ Tools to import/export TOSCA definitions in YAML from/to ETSI Specifications in Docx format. -Currently supports ETSI GS NFV-SOL 001. +Currently supports ETSI GS NFV-SOL 001 (versions from 2.4.1 to 3.3.1). -This tool is provided as-is, no guarantees are applicable on the correctnes of the output. +This tool is provided as-is, no guarantees are applicable on the correctness of the output. Use at your own risk. ## Create `env` file +The `env` file is used for environment settings. + cp env_example env $EDITOR env # Customize SECRET @@ -22,7 +24,12 @@ Run the container with docker run -d -t -p 5000:5000 tosca-ie-sample -## Run locally +### Relaunch utility + +A simple tool is provided to rebuild, kill and relaunch the container in a deployment. See `relaunch.sh`. + + +## Run web app locally Install prerequisites -- GitLab