summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAloXado320 <38191089+AloXado320@users.noreply.github.com>2023-11-05 15:57:14 -0500
committerGitHub <noreply@github.com>2023-11-05 13:57:14 -0700
commit959c933714e07e9832851df27a04ded23df00d81 (patch)
treea74bffb36cc8626af128e23162cd401dd7334d09 /README.md
parent596fa15e8dd834eac7c2af2311f61d018a038e2f (diff)
Document progress.py and correct readme (#483)
* Document progress.py and adjust readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 14 insertions, 18 deletions
diff --git a/README.md b/README.md
index 1862869d2..e0ae47f97 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,21 @@
# Mario Kart 64
+This work-in-progress decompilation of Mario Kart 64 pursues historical and educational elements within the game found via taking it apart and putting it back together. Inspiration to do so not only emanates from the game's hardware and technology but also its immensely positive effects on the cultures and families of nearly every nationality. See [progress](#Progress) for more information.
-```diff
-- Note -
+This repository does not contain assets. Compiling requires asset extraction from a prior copy of the game.
-The decomp has altered its approach to calculating progress.
+It supports and builds the following versions:
-The progress script is still a work-in-progress and the values below are subject to change.
-This notice will be removed when the changes are complete
-```
+| ROM Output | Revision| SHA-1 Checksum |
+|-------------------|---------|------------------------------------------|
+| mk64.us.z64 | USA | 579c48e211ae952530ffc8738709f078d5dd215e |
+| mk64.eu-1.0.z64 | EUR 1.0 | a729039453210b84f17019dda3f248d5888f7690 |
+| mk64.eu-final.z64 | EUR 1.1 | f6b5f519dd57ea59e9f013cc64816e9d273b2329 |
+
+## Score progress
+
+Total progress consists of all code segments together.
+
+Game code progress consists of `main`, `ending` and `racing`.
[![Build Status](https://ci.valandil.ca/buildStatus/icon?job=mk64%2Fmaster&config=totalProgress)](https://ci.valandil.ca/job/mk64/job/master/)
[![Build Status](https://ci.valandil.ca/buildStatus/icon?job=mk64%2Fmaster&config=gameProgress)](https://ci.valandil.ca/job/mk64/job/master/)
@@ -22,18 +30,6 @@ This notice will be removed when the changes are complete
- [![Build Status](https://ci.valandil.ca/buildStatus/icon?job=mk64%2Fmaster&config=audioProgress)](https://ci.valandil.ca/job/mk64/job/master/)
- [![Build Status](https://ci.valandil.ca/buildStatus/icon?job=mk64%2Fmaster&config=osProgress)](https://ci.valandil.ca/job/mk64/job/master/)
-This work-in-progress decompilation of Mario Kart 64 (U), (E 1.0) and (E 1.1) pursues historical and educational elements within the game found via taking it apart and putting it back together. Inspiration to do so not only emanates from the game's hardware and technology but also its immensely positive effects on the cultures and families of nearly every nationality. See [progress](#Progress) for more information.
-
-It builds the following ROMs:
-
-| ROM Output | Revision | MD5 Checksum |
-|------------|----------------|------------------------------------------|
-| mk64.us.z64 | USA | 579c48e211ae952530ffc8738709f078d5dd215e |
-| mk64.eu-1.0.z64 | EUR 1.0 | a729039453210b84f17019dda3f248d5888f7690 |
-| mk64.eu-final.z64 | EUR 1.1 | f6b5f519dd57ea59e9f013cc64816e9d273b2329 |
-
-This repository does not contain assets. Compiling requires asset extraction from a prior copy of the game.
-
## Dependencies
The build system has the following package requirements: