Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aurelf committed May 14, 2024
1 parent cf684f2 commit c16ac5b
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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
Expand Down

0 comments on commit c16ac5b

Please sign in to comment.