From 25744dda7212b2c0fa1a5e8ff49785d5e146cbf9 Mon Sep 17 00:00:00 2001 From: Jeremy Burns Date: Fri, 20 May 2022 10:40:00 -0600 Subject: [PATCH] Explain public API (#14) --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f534545..cb26825 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ This project produces a shared library file containing mostly code from the deco and loads an official SM64 ROM at runtime to get Mario's texture and animation data, so any project which makes use of this library must ask the user to provide a ROM for asset extraction. +The entire external-facing API of the shared library can be found in `libsm64.h`. Any client project +making use of the library must only include that header and load the library. There's a minimal example +project under the `test` directory as well, demonstrating usage of the library. + ## Bindings and plugins - [Rust bindings](https://github.com/nickmass/libsm64-rust)