From dd391bbf32521765016dc41c24e79143da646f35 Mon Sep 17 00:00:00 2001
From: Martin <martin.hogstedt@hotmail.com>
Date: Fri, 3 Nov 2023 11:30:19 +0100
Subject: [PATCH] added installion to the readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index b778679..79bb392 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
-- 
GitLab