changed docs

Ferryistaken · Apr 1, 2024 · eddd4c1 · eddd4c1
1 parent bc8125e
commit eddd4c1
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/src/chip8.rs b/src/chip8.rs
@@ -35,6 +35,24 @@ pub struct Chip8 {
 impl Chip8 {
     /// Create a new chip8 instance with an empty `rom`, ready for use
     ///
+    /// # Example:
+    ///
+    /// ```
+    /// let mut chip8: Chip8 = Chip8::new();
+    ///
+    /// chip.load_rom(path);
+    ///
+    /// let rom: PathBuf = '...';
+    /// let speed: u64 = 30;
+    ///
+    /// loop {
+    ///
+    ///     chip8.Cycle();
+    ///     chip8.pretty_print_video(rom);
+    ///     thread::sleep(time::Duration::from_millis(speed);
+    /// }
+    /// ```
+    ///
     /// ## Values
     ///
     /// * `registers`: all zeroes