diff --git a/README.md b/README.md index 82ecdb4..aa8cf30 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # N64 Modern Runtime -> Note -This repo is a WIP as files are moved out of Zelda64Recomp and genericized. It cannot be used directly in its current state. +A modern runtime for traditional ports and recompilations of N64 games. \ +The runtime is consists of two libraries: [ultramodern](#ultramodern) and [librecomp](#librecomp). -This repo contains two libraries: Ultramodern and Librecomp. +## ultramodern -## Ultramodern - -Ultramodern is a reimplementation of much of the core functionality of libultra. It can be used with either statically recompiled projects that use N64Recomp or direct source ports. It implements the following libultra functionality: +ultramodern is a reimplementation of much of the core functionality of libultra. It can be used with either statically recompiled projects that use N64Recomp or direct source ports. It implements the following libultra functionality: * Threads * Controllers @@ -21,9 +19,9 @@ Platform-specific I/O is handled via callbacks that are provided by the project ultramodern expects the user to provide and register a graphics renderer. The recommended one is [RT64](https://github.com/rt64/rt64). -## Librecomp +## librecomp -Librecomp is a library meant to be used to bridge the gap between code generated by N64Recomp and ultramodern. It provides wrappers to allow recompiled code to call ultramodern. Librecomp also provides some of the remaining libultra functionality that ultramodern doesn't provide, which includes: +librecomp is a library meant to be used to bridge the gap between code generated by N64Recomp and ultramodern. It provides wrappers to allow recompiled code to call ultramodern. Librecomp also provides some of the remaining libultra functionality that ultramodern doesn't provide, which includes: * Overlay handling * PI DMA (ROM reads)