Merge pull request #10 from craigthomas/code-coverage-increase

Update dependency badge, remove unit test descriptions, add unit tests.

Author: craigthomas

README.md

@@ -3,7 +3,22 @@
 [![Build Status](https://travis-ci.org/craigthomas/Chip8Python.svg?branch=master)](https://travis-ci.org/craigthomas/Chip8Python) 
 [![codecov](https://codecov.io/gh/craigthomas/Chip8Python/branch/master/graph/badge.svg)](https://codecov.io/gh/craigthomas/Chip8Python) 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/f100b6deb9bf4729a2c55ef12fb695c9)](https://www.codacy.com/app/craig-thomas/Chip8Python?utm_source=github.com&utm_medium=referral&utm_content=craigthomas/Chip8Python&utm_campaign=Badge_Grade)
-[![Dependency Status](https://dependencyci.com/github/craigthomas/Chip8Python/badge)](https://dependencyci.com/github/craigthomas/Chip8Python)
+[![Dependency Status](https://dependencyci.com/github/craigthomas/Chip8Python/badge?style=flat)](https://dependencyci.com/github/craigthomas/Chip8Python)
+
+
+## Table of Contents
+
+1. [What is it?](#what-is-it)
+2. [License](#license)
+3. [Installing](#installing)
+    1. [Ubuntu Installation](#ubuntu-installation)
+    2. [Windows Installation](#windows)
+4. [Running](#running)
+    1. [Running a ROM](#running-a-rom)
+    2. [Screen Scale](#screen-scale)
+    3. [Execution Delay](#execution-delay)
+5. [Customization](#customization)
+6. [Further Documentation](#further-documentation)
 
 ## What is it?
 
@@ -38,52 +53,124 @@ I strongly recommend creating a virtual environment using the
 With these tools, you can easily create a virtual sandbox to install pygame
 and run the emulator in, without touching your master Python environment.
 
+
 ### Ubuntu Installation
 
 The installation under Ubuntu requires several different steps:
 
-1) Install SDL libraries. The SDL (Simple DirectMedia Layer) libraries are 
-used by PyGame to draw images on the screen. Several other dependencies are
-needed by SDL in order to install PyGame. To install the required SDL 
-libraries (plus dependencies) from the command-line:
+1. Install SDL libraries. The SDL (Simple DirectMedia Layer) libraries are used by PyGame to draw 
+images on the screen. Several other dependencies are needed by SDL in order to install PyGame. 
+To install the required SDL libraries (plus dependencies) from the command-line:
+
+    ```
+    sudo apt-get install libfreetype6-dev libsdl-dev libsdl-image1.2-dev \ 
+    libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsdl-sound1.2-dev \
+    libportmidi-dev python-dev
+    ```
+
+2. Install PIP. The `pip` package manager is used for managing Python packages. To install `pip` 
+from the command-line:
+
+    ```
+    sudo apt-get install python-pip
+    ```
+
+3. (*Optional*) Install virtual environment support for Python:
+
+    1. Install virtual environment support:
+
+    ```
+    pip install virtualenv
+    pip install virtualenvwrapper
+    ```
+
+    2. First you must update your `.bashrc` file in the your home directory and add a few lines 
+    to the bottom of that file:
+
+    ```
+    cat >> ~/.bashrc << EOF
+    export WORKON_HOME=$HOME/.virtualenvs
+    source /usr/local/bin/virtualenvwrapper.sh
+    EOF
+    ```
+
+    3. Next you must source the `.bashrc` file:
+
+    ```
+    source ~/.bashrc
+    ```
+
+    4. Finally you can create the environment:
 
-        sudo apt-get install libfreetype6-dev libsdl-dev libsdl-image1.2-dev \ 
-        libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsdl-sound1.2-dev \
-        libportmidi-dev python-dev
-    
-2) Install Mercurial. The `hg` command-line tool is required when using 
-`pip` (see next step) to install the requirements for the project. To
-install Mercurial from the command-line:
+    ```
+    mkvirtualenv chip8
+    ```
 
-        sudo apt-get install mercurial
-    
-3) Install PIP. The `pip` package manager is used for managing Python
-packages. To install `pip` from the command-line:
+5. Clone (or download) the Chip 8 emulator project:
 
-        sudo apt-get install wget
-        wget https://bootstrap.pypa.io/get-pip.py
-        sudo python ./get-pip.py
-        
-4) Clone (or download) the Chip 8 emulator project:
+    ```
+    sudo apt-get install git
+    git clone https://github.com/craigthomas/Chip8Python.git
+    ```
 
-        sudo apt-get install git
-        git clone [email protected]:craigthomas/Chip8Python.git
-        
-5) Install the requirements from the project:
+6. Install the requirements from the project:
 
-        pip install -r requirements.txt
+    ```
+    pip install -r requirements.txt
+    ```
+
+
+### Windows Installation
+
+1. Download and install [Python 2.7.15 for Windows](https://www.python.org/downloads/release/python-2715/). 
+Make sure that `pip` and `Add python.exe to Path` options are checked when performing the installation.
+
+2. (*Optional*) Install virtual environment support for Python. Run the following commands from a command prompt:
+
+    1. Install the virtual environment wrapper:
+
+    ```
+    pip install virtualenv
+    pip install virtualenvwrapper-win
+    ```
+
+    2. Create a new environment for the Chip 8 emulator:
+
+    ```
+    mkvirtualenv chip8
+    ```
+
+4. Install [Git for Windows](https://git-scm.com/download/win).
+
+5. Clone (or download) the source files from GitHub. Run the following commands in a command prompt window:
+
+    ```
+    git clone https://github.com/craigthomas/Chip8Python.git
+    ```
+
+6. Install the requirements for the project. Run the following commands in a command prompt window 
+in the directory where you cloned or downloaded the source files:
+
+    ```
+    pip install -r requirements.txt
+    ```
 
 
 ## Running
 
 ### Running a ROM
 
 The command-line interface requires a single argument, which is the full
-path to a Chip 8 ROM:
+path to a Chip 8 ROM. Run the following command in the directory where you 
+cloned or downloaded the source files:
 
     python chip8/yac8e.py /path/to/rom/filename
 
-This will start the emulator with the specified ROM.
+This will start the emulator with the specified ROM. Note that if you created 
+a virtual environment as detailed above, you will need to `workon` that 
+environment before starting the emulator:
+
+    workon chip8
 
 ### Screen Scale
 

chip8/cpu.py

@@ -140,6 +140,7 @@ def __init__(self, screen):
         self.screen = screen
         self.memory = bytearray(MAX_MEMORY)
         self.reset()
+        self.running = True
 
     def __str__(self):
         val = 'PC: {:4X}  OP: {:4X}\n'.format(
@@ -257,7 +258,7 @@ def clear_return(self):
             self.screen.scroll_left()
 
         if operation == 0x00FD:
-            pass
+            self.running = False
 
         if operation == 0x00FE:
             self.disable_extended_mode()
@@ -667,12 +668,12 @@ def draw_normal(self, x_pos, y_pos, num_bytes):
             color_byte = bin(self.memory[self.registers['index'] + y_index])
             color_byte = color_byte[2:].zfill(8)
             y_coord = y_pos + y_index
-            y_coord = y_coord % self.screen.height
+            y_coord = y_coord % self.screen.get_height()
 
             for x_index in xrange(8):
 
                 x_coord = x_pos + x_index
-                x_coord = x_coord % self.screen.width
+                x_coord = x_coord % self.screen.get_width()
 
                 color = int(color_byte[x_index])
                 current_color = self.screen.get_pixel(x_coord, y_coord)

chip8/yac8e.py

@@ -55,26 +55,22 @@ def main_loop(args):
     cpu.load_rom(FONT_FILE, 0)
     cpu.load_rom(args.rom)
     pygame.time.set_timer(TIMER, DELAY_INTERVAL)
-    running = True
 
-    while running:
+    while cpu.running:
         pygame.time.wait(args.op_delay)
-        operand = cpu.execute_instruction()
+        cpu.execute_instruction()
 
         # Check for events
         for event in pygame.event.get():
             if event.type == TIMER:
                 cpu.decrement_timers()
             if event.type == pygame.QUIT:
-                running = False
+                cpu.running = False
             if event.type == pygame.KEYDOWN:
                 keys_pressed = pygame.key.get_pressed()
                 if keys_pressed[pygame.K_q]:
-                    running = False
+                    cpu.running = False
 
-        # Check to see if CPU is in exit state
-        if operand == 0x00FD:
-            running = False
 
 # M A I N #####################################################################
 

requirements.txt

@@ -1,3 +1,3 @@
-hg+http://bitbucket.org/pygame/pygame
+pygame
 coveralls
 mock