From 2f38edee708745b139d34d372e53b7fb11f99d68 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Rativel?=
 <remi.rativel@etudiant.univ-rennes1.fr>
Date: Wed, 10 May 2023 08:02:25 +0200
Subject: [PATCH] Module description

---
 src/simulator/mod.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/simulator/mod.rs b/src/simulator/mod.rs
index f764fbd..03108e1 100644
--- a/src/simulator/mod.rs
+++ b/src/simulator/mod.rs
@@ -1,3 +1,12 @@
+//! This module implement an Instruction simulator
+//! with all the simulated hardware requested to run the Machine :
+//! - **MMU**
+//! - **Processor**
+//! - **RAM**
+//! - **Interruption Controler**
+//!
+//! The disk, the console and the serial coupler aren't implmented for now
+//!
 pub mod machine;
 pub mod error;
 pub mod instruction;