Merge branch 'master' of github.com:leonmavr/chip-8

leonmavr · Aug 14, 2024 · e9c8c34 · e9c8c34
2 parents f27bd6d + 701e73b
commit e9c8c34
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 13 deletions.
diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml
@@ -4,13 +4,17 @@ on:
   push:
     branches: [ "master" ]
     paths-ignore:
-      - 'README*'
+      - '*README*'
       - 'assets/**'
+      - 'roms/**'
+      - 'LICENSE*'
   pull_request:
     branches: [ "master" ]
     paths-ignore:
-      - 'README*'
+      - '*README*'
       - 'assets/**'
+      - 'roms/**'
+      - 'LICENSE*'
 
 jobs:
   build:
@@ -19,5 +23,5 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - name: compile and test
+    - name: compile and run sanity test(s)
       run: make test
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 ```
-    ▒▒▒▒▒▒ ▒▒▒▒▒       ▒▒▒▒▒ ▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒     ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
-  ▒▒▒▒▒▒    ▒▒▒▒       ▒▒▒▒  ▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒   ▒▒▒▒       ▒▒▒▒
-▒▒▒▒▒▒       ▒▒▒       ▒▒▒     ▒▒▒▒   ▒▒   ▒▒▒▒▒▒ ▒▒▒▒       ▒▒▒▒
-▒▒▒▒▒▒       ▒▒▒▒▒▒▒▒▒▒▒▒▒     ▒▒▒▒   ▒▒  ▒▒▒▒▒   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
-▒▒▒▒▒▒       ▒▒▒▒▒▒▒▒▒▒▒▒▒     ▒▒▒▒   ▒▒▒▒▒▒▒     ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
-▒▒▒▒▒▒       ▒▒▒       ▒▒▒     ▒▒▒▒   ▒▒▒▒        ▒▒▒▒       ▒▒▒▒
-  ▒▒▒▒▒▒    ▒▒▒▒       ▒▒▒▒  ▒▒▒▒▒▒▒▒ ▒▒▒▒        ▒▒▒▒       ▒▒▒▒
-    ▒▒▒▒▒▒ ▒▒▒▒▒       ▒▒▒▒▒ ▒▒▒▒▒▒▒▒ ▒▒▒▒        ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+    ▒▒▒▒▒▒ ▒▒▒▒▒       ▒▒▒▒▒ ▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒     ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+  ▒▒▒▒▒▒    ▒▒▒▒       ▒▒▒▒  ▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒   ▒▒▒▒       ▒▒▒▒
+▒▒▒▒▒▒       ▒▒▒       ▒▒▒     ▒▒▒▒   ▒▒▒   ▒▒▒▒▒▒ ▒▒▒▒       ▒▒▒▒
+▒▒▒▒▒▒       ▒▒▒▒▒▒▒▒▒▒▒▒▒     ▒▒▒▒   ▒▒▒  ▒▒▒▒▒   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+▒▒▒▒▒▒       ▒▒▒▒▒▒▒▒▒▒▒▒▒     ▒▒▒▒   ▒▒▒▒▒▒▒▒     ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+▒▒▒▒▒▒       ▒▒▒       ▒▒▒     ▒▒▒▒   ▒▒▒▒▒        ▒▒▒▒       ▒▒▒▒
+  ▒▒▒▒▒▒    ▒▒▒▒       ▒▒▒▒  ▒▒▒▒▒▒▒▒ ▒▒▒▒▒        ▒▒▒▒       ▒▒▒▒
+    ▒▒▒▒▒▒ ▒▒▒▒▒       ▒▒▒▒▒ ▒▒▒▒▒▒▒▒ ▒▒▒▒▒        ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
 ```
 # 1. About
 
@@ -168,8 +168,8 @@ counter   |           pointer     |    Index register    +---+    +---+
 The emulator uses 3 threads in total. More detailed comments on how the fetch-
 decode-execute cycle works are found in the source file `chip8.cpp`. Some
 forbidden unoptomised programming was used to write the instruction table but
-it's my hobby project so I make the rules. Techinal resources are found in the
-reference section.
+it's my hobby project so I make the rules. More comprehensive techninal 
+resources are found in the reference section.
 
 ### 4.3 Implementation quirks