diff --git a/README.md b/README.md index b77867985bff736c559fc97f684de703e44d9173..79bb392b75019ff29b511117caceb238a3da764d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,23 @@ Program for building and simulating processors. Build architectures easily with # Documentation https://da.gitlab-pages.liu.se/simudator/ +# Installation + +Create a virtual environments with: + +`python -m venv path/to/venv` + +Enter the virtual environments and run: + +`pip install -ve .` + +The project requires either pyqt5 or pyqt6. Install one of them. + +Now run a processor such as mia, by running the command: + +`python src/simudator/processor/mia/mia.py` + + # Implementation details ## Modules and Signals