Commit dfb3933e authored by carignani's avatar carignani
Browse files

Improve docs

parent c29ba673

Readme.md

+10 −3
Original line number Original line Diff line number Diff line
@@ -2,13 +2,15 @@ 




Tools to import/export TOSCA definitions in YAML from/to ETSI Specifications in Docx format.

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.

Use at your own risk.





## Create `env` file

## Create `env` file





The `env` file is used for environment settings.



   cp env_example env

   cp env_example env

   $EDITOR env # Customize SECRET

   $EDITOR env # Customize SECRET
@@ -22,7 +24,12 @@ Run the container with 




    docker run -d -t -p 5000:5000 tosca-ie-sample

    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 

Install prerequisites