README.tpl

# Generated LinuxCNC HAL Rust bindings

[![CircleCI](https://circleci.com/gh/jamwaffles/linuxcnc-hal-rs.svg?style=shield)](https://circleci.com/gh/jamwaffles/linuxcnc-hal-rs)
[![Crates.io](https://img.shields.io/crates/v/linuxcnc-hal-sys.svg)](https://crates.io/crates/linuxcnc-hal-sys)
[![Docs.rs](https://docs.rs/linuxcnc-hal-sys/badge.svg)](https://docs.rs/linuxcnc-hal-sys)
[![Liberapay](https://img.shields.io/badge/donate-liberapay-yellow.svg)](https://liberapay.com/jamwaffles)

Please consider [becoming a sponsor](https://github.com/sponsors/jamwaffles/) so I may continue to maintain this crate in my spare time!

# [Documentation](https://docs.rs/linuxcnc-hal-sys)

{{readme}}

## 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.

### Contribution

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.

[`hal_init`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/fn.hal_init.html
[`hal_malloc`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/fn.hal_malloc.html
[`hal_ready`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/fn.hal_ready.html
[`hal_pin_u32_new`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/fn.hal_pin_u32_new.html
[`hal_pin_float_new`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/fn.hal_pin_float_new.html
[`EINVAL`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/constant.EINVAL.html
[`EPERM`]: https://docs.rs/linuxcnc-hal-sys/latest/linuxcnc_hal_sys/constant.EPERM.html