Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add crate summaries to README.md #40

Merged
merged 2 commits into from
Dec 16, 2022
Merged

Add crate summaries to README.md #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ec42c0
Add crate summaries to README.md
erlend-sh Dec 11, 2022
a23d774
Merge branch 'jjant:master' into patch-1
erlend-sh Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down