From 3ec42c04d9ba463731a63af484234b5baff85d33 Mon Sep 17 00:00:00 2001 From: Erlend Sogge Heggen Date: Sun, 11 Dec 2022 19:18:22 +0100 Subject: [PATCH] Add crate summaries to README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 817adbe5..d9717394 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,15 @@ A Pico8 clone in Rust. Head over to our [template](https://github.com/jjant/runty8-game-template) for an example to get started! +## Crates + +* `runty8`: Main entry point for games created with Runty8. Most Runty8 users should probably only depend on this crate. +* `runty8-core`: Core types needed by every Runty8 related crate +* `runty8-runtime`: Run standalone Runty8 games in `native` or `wasm` targets +* `runty8-editor`: Run game inside editor +* `runty8-winit`: Integration layer for `winit` +* `runty8-event-loop`: Thin layer over `winit`/`glow`/`glutin` to have a cross-platform OpenGL/WebGL-powered event loop + ## Contributing See [the contributing guide](./CONTRIBUTING.md) for instructions on how to get started.