# ctru-rs

A Rust wrapper library for smealum's [ctrulib](https://github.com/smealum/ctrulib).

## Structure

This repository is organized as follows:

* `ctru-rs`: Safe, idiomatic wrapper around `ctru-sys`

* `ctru-sys`: Low-level, unsafe bindings to ctrulib.

  This crate's version changes according to the version of `libctru`
  used to generate the bindings, with the following convention:

  * `libctru` version `X.Y.Z-W`
  * `ctru-sys` version `XY.Z.P+X.Y.Z-W`

  where `P` is usually 0 but may be incremented for fixes in e.g.
  binding generation, `libc` dependency bump, etc.

  It may be possible to build this crate against a different version of `libctru`,
  but you may encounter linker errors or ABI issues. A build-time Cargo warning
  (displayed when built with `-vv`) will be issued if the build script detects
  a mismatch or is unable to check the installed `libctru` version.

## License

Copyright (C) Rust 3DS Project authors, 2015-2016

See AUTHORS.md.

As with the original ctrulib, this library is licensed under zlib. This
applies to every file in the tree, unless otherwise noted.

    This software is provided 'as-is', without any express or implied
    warranty.  In no event will the authors be held liable for any
    damages arising from the use of this software.

    Permission is granted to anyone to use this software for any
    purpose, including commercial applications, and to alter it and
    redistribute it freely, subject to the following restrictions:

    1. The origin of this software must not be misrepresented; you
       must not claim that you wrote the original software. If you use
       this software in a product, an acknowledgment in the product
       documentation would be appreciated but is not required.
    2. Altered source versions must be plainly marked as such, and
       must not be misrepresented as being the original software.
    3. This notice may not be removed or altered from any source
       distribution.

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See [LICENSE-APACHE](https://github.com/rust-lang/rust/blob/master/LICENSE-APACHE), [LICENSE-MIT](https://github.com/rust-lang/rust/blob/master/LICENSE-MIT), and [COPYRIGHT](https://github.com/rust-lang/rust/blob/master/COPYRIGHT) for details.