diff --git a/README.md b/README.md index 5161757..3ecedfc 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,14 @@ # qp-demo This is the component used in the [Quantum Package demo]( https://quantumpackage.github.io/qp2/page/try) +This repo contains +- `examples`: Examples included with quantum package docker image. -- examples: Examples included with quantum package docker image. - -- Dockerfile: This is a multi-stage dockerfile used to create the docker image from the [Quantum Package GitHub repo](https://github.com/QuantumPackage/qp2) - -- run.sh: run the image in the context of the demo. (With isolated network, a limited number of container and a time limit) - -## What is Docker -Docker is a containerization software. -For more info about it you can cosult the official [Docker documentation](https://docs.docker.com) - -## How to build the image - -### Precompiled - -run `make` - -A tar.gz archive of quantum package is needed at the root of the project with the name `quantum_package_static.tar.gz` - -This archive can be create with the command `qp_export_as_tgz` of quantum package - -### Compiled from github - -run `make compile` +- `Dockerfile`: This is a multi-stage dockerfile used to create the docker image from the [Quantum Package GitHub repo](https://github.com/QuantumPackage/qp2) There is no guarantee of success because it's use the Quantum Package ./configure tool to install third party dependencies. -## Before use run.sh - -We must run `make network` before the first use of run.sh because it use a custom network bridge to disable communication between QP2 containers \ No newline at end of file +- `run.sh`: run the image in the context of the demo. (With isolated network, a limited number of container and a time limit) +before the first use of run.sh `Run.sh` we must run `make network` because it use a custom network bridge to disable communication between the QP2 containers. +## What is Docker +Docker is a containerization software. +For more info about it you can consult the official [Docker documentation](https://docs.docker.com) \ No newline at end of file