# `limine-rs`

[![build](https://github.com/limine-bootloader/limine-rs/workflows/Build/badge.svg)](https://github.com/limine-bootloader/limine-rs/actions)
![downloads](https://img.shields.io/crates/d/limine)
[![version](https://img.shields.io/crates/v/limine)](https://crates.io/crates/limine)
[![docs](https://docs.rs/limine/badge.svg)](https://docs.rs/limine)
![license](https://img.shields.io/crates/l/limine)

Rust crate for parsing the limine boot protocol structures.

## Resources
* [Limine Boot Protocol Specification](https://github.com/limine-bootloader/limine/blob/trunk/PROTOCOL.md)

## Barebones
An example project utilizing the crate can be found [here](https://github.com/limine-bootloader/limine-rust-barebones).

**Note**: In order to compile and run the barebones kernel, **nightly** Rust is required.

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.