From c16ac5b64c7f58095f192658633a756c81ddb239 Mon Sep 17 00:00:00 2001 From: Aurelien Francillon Date: Tue, 14 May 2024 13:50:51 +0200 Subject: [PATCH] Update documentation --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index febeceec81..30cbd6a6c1 100644 --- a/README.md +++ b/README.md @@ -101,11 +101,13 @@ docker run -it --rm symqemu ## Build with Docker Compose -Sometimes, it is more convenient to use docker-compose while developing SymQEMU, especially to avoid rebuilding for -each change. It can both build `symqemu` and `symqemu-dev`. +Sometimes, it is more convenient to use docker-compose while developing SymQEMU, +especially to avoid rebuilding for each change. It can both build `symqemu` and +`symqemu-dev`. -Beware however, the container and the host directory will be synchronized: each change in the container's source folder -will be reflected on the host and vice versa (except for the build subfolder). +Beware however, the container and the host directory will be synchronized: each +change in the container's source folder will be reflected on the host and vice +versa (except for the build subfolder). A script is available to quickly get docker-compose: `./dev.sh`. @@ -122,7 +124,19 @@ docker-compose up -d symqemu-dev It is finally possible to attach to the container: ```bash docker-compose exec -it symqemu-dev /bin/bash -```` +``` + +Building and testing in one line (confugure only needed the first time, it is +automatically rerun when needed): + +```bash +docker-compose exec -it symqemu-dev /bin/bash -c "cd build && /configure_symqemu.sh && make -j && make check" +``` + +Running symqemu integration tests: +```bash +docker-compose exec -it symqemu-dev /bin/bash -c "cd /symqemu_source/tests/symqemu && python3 -m unittest test.py" +``` ## Contributing