Closes #187

rust-console · Mar 4, 2024 · 1746db0 · 1746db0
1 parent 35724f5
commit 1746db0
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,16 @@
 # `gba`
 
 # [Docs.rs Documentation](https://docs.rs/gba)
+
+This crate is intended for working with the GBA.
+
+To build for the GBA you'll need to use `build-std` and you'll also need to
+activate the `compiler-builtins-weak-intrinsics` feature.
+
+The following should be somewhere in your `.cargo/config.toml`:
+
+```toml
+[unstable]
+build-std = ["core"]
+build-std-features = ["compiler-builtins-weak-intrinsics"]
+```