projects / rustc.git / blame
| Commit | Line | Data |
|---|---|---|
| f20569fa XL |
1 | [](https://crates.io/crates/dirs-sys-next) |
| 2 | [](https://docs.rs/dirs-sys-next/) | |
| 3 | ||
| 4 | # `dirs-sys-next` | |
| 5 | ||
| 6 | **NOTE**: This crate is a fork of once-abandoned `dirs-sys` crate. | |
| 7 | ||
| 8 | _Do not use this library directly, use [`dirs-next`] or [`directories-next`]._ | |
| 9 | ||
| 10 | ## Compatibility | |
| 11 | ||
| 12 | This crate only exists to facilitate code sharing between [`dirs-next`] | |
| 13 | and [`directories-next`]. | |
| 14 | ||
| 15 | There are no compatibility guarantees whatsoever. | |
| 16 | Functions may change or disappear without warning or any kind of deprecation period. | |
| 17 | ||
| 18 | ## Platforms | |
| 19 | ||
| 20 | This library is written in Rust, and supports Linux, Redox, macOS and Windows. | |
| 21 | Other platforms are also supported; they use the Linux conventions. | |
| 22 | ||
| 23 | ## Minimum Rust version policy | |
| 24 | ||
| 25 | The minimal required version of Rust is `1.34.0`^. | |
| 26 | ||
| 27 | We may bump the Rust version in major and minor releases (`x`/`y` in `x.y.z`). | |
| 28 | Changing the Rust version will be written in the CHANGELOG. | |
| 29 | ||
| 30 | ^ Except for Redox, where the Rust version depends on the | |
| 31 | [`redox_users`](https://crates.io/crates/redox_users) crate. | |
| 32 | ||
| 33 | ## Build | |
| 34 | ||
| 35 | It's possible to cross-compile this library if the necessary toolchains are installed with rustup. | |
| 36 | This is helpful to ensure a change has not broken compilation on a different platform. | |
| 37 | ||
| 38 | The following commands will build this library on Linux, macOS and Windows: | |
| 39 | ||
| 40 | ```console | |
| 41 | cargo build --target=x86_64-unknown-linux-gnu | |
| 42 | cargo build --target=x86_64-pc-windows-gnu | |
| 43 | cargo build --target=x86_64-apple-darwin | |
| 44 | cargo build --target=x86_64-unknown-redox | |
| 45 | ``` | |
| 46 | ||
| 47 | ## License | |
| 48 | ||
| 49 | Licensed under either of | |
| 50 | ||
| 51 | * Apache License, Version 2.0 | |
| 52 | ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) | |
| 53 | * MIT license | |
| 54 | ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) | |
| 55 | ||
| 56 | at your option. | |
| 57 | ||
| 58 | ## Contribution | |
| 59 | ||
| 60 | Unless you explicitly state otherwise, any contribution intentionally submitted | |
| 61 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall be | |
| 62 | dual licensed as above, without any additional terms or conditions. | |
| 63 | ||
| 64 | [`dirs-next`]: https://github.com/xdg-rs/dirs | |
| 65 | [`directories-next`]: https://github.com/xdg-rs/dirs/tree/master/directories |