📝 Documentation updates

This commit is contained in:
François Autin
2023-03-24 19:02:50 +01:00
parent 4e90d9fef7
commit 7ed53261a0
4 changed files with 39 additions and 12 deletions

View File

@ -1,3 +1,16 @@
//! # Machine
//!
//! This module contains a RISC-V simulator.
//! It supports the base instruction set along
//! with 32bit floating point operations.
//!
//! Basic usage:
//!
//! ```
//! let mut machine = Machine::init_machine();
//! machine.run();
//! ```
use std::{
io::Write,
fs::File