# Nova r8 Rust bindings

## Table of Contents
- [Description](#description)
- [Install](#install)
- [Usage](#usage)
- [References](#references)
- [Maintainers](#maintainers)
- [Contributing](#contributing)

## Description
This library comprises Rust bindings for the [Nova r8][nova-r8] game engine.

## Install
1. Adhere to the installation guidelines for installing the essential [Nova r8][nova-r8] library.

## Usage
Create a new project named `my-game`.
```bash
$ cargo new my-game
$ cd my-game
$ cargo add nova-r8
```

Add the following content to the `src/main.rs` file to instantiate a blank window.
```rust
use nova_r8::*;

fn main() {
    let g = Game::new();

    while g.run() {
    }
}
```
#### Build:
```bash
$ cargo build
```
#### Run:
```bash
$ ./target/debug/my-game
```

## References
Refer to the [Nova r8][nova-r8] project for comprehensive references.
### Structs
#### `nova_r8::Game`
#### `nova_r8::Actor`
#### `nova_r8::Vec2`

## Maintainers
[~klahr](https://sr.ht/~klahr)

## Contributing
We enthusiastically encourage and welcome contributions.

[nova-r8]: https://git.sr.ht/~klahr/nova-r8