diff options
Diffstat (limited to '')
| -rw-r--r-- | vendor/termize/README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/vendor/termize/README.md b/vendor/termize/README.md new file mode 100644 index 000000000..1c5ce32d3 --- /dev/null +++ b/vendor/termize/README.md @@ -0,0 +1,51 @@ +termize +==== + +[](https://crates.io/crates/termize) [](https://crates.io/crates/termize) [](https://github.com/JohnTitor/termize/blob/master/LICENSE-MIT) [](https://github.com/JohnTitor/termize/blob/master/LICENSE-APACHE) [](https://github.com/JohnTitor/termize/workflows/CI) [](https://cirrus-ci.com/github/JohnTitor/termize) + +A Rust library to enable getting terminal sizes and dimensions + +**This is a fork repository, original is [here](https://github.com/clap-rs/term_size-rs).** + +MSRV (Minimum Supported Rust Version): 1.31.1 + +[Documentation](https://docs.rs/termize) + +## Usage + +First, add the following to your `Cargo.toml`: + +```toml +[dependencies] +termize = "0.1" +``` + +To get the dimensions of your terminal window, simply use the following: + +```rust +fn main() { + if let Some((w, h)) = termize::dimensions() { + println!("Width: {}\nHeight: {}", w, h); + } else { + println!("Unable to get term size :("); + } +} +``` + +## License + +Copyright Benjamin Sago, Kevin Knapp, Yuki Okushi, and `term_size`/`termize` contributors. + +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. + +## Contributing + +Contributions are welcome! Here is our [CONTRIBUTING GUIDE](./CONTRIBUTING.md). |