diff options
Diffstat (limited to 'third_party/rust/term_size/README.md')
| -rw-r--r-- | third_party/rust/term_size/README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/third_party/rust/term_size/README.md b/third_party/rust/term_size/README.md new file mode 100644 index 0000000000..9f9c6f26aa --- /dev/null +++ b/third_party/rust/term_size/README.md @@ -0,0 +1,63 @@ +term_size +==== + +[](https://crates.io/crates/term_size) [](https://crates.io/crates/term_size) [](https://github.com/kbknapp/term_size-rs/blob/master/LICENSE-MIT) [](https://github.com/kbknapp/term_size-rs/blob/master/LICENSE-APACHE) [](https://coveralls.io/github/kbknapp/term_size-rs?branch=master) [](https://gitter.im/kbknapp/term_size-rs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +Linux: [](https://travis-ci.org/kbknapp/term_size-rs) +Windows: [](https://ci.appveyor.com/project/kbknapp/term_size-rs/branch/master) + +A Rust library to enable getting terminal sizes and dimensions + +[Documentation](https://kbknapp.github.io/term_size-rs) + +## Usage + +First, add the following to your `Cargo.toml`: + +```toml +[dependencies] +term_size = "0.3" +``` + +Next, add this to your crate root: + +```rust +extern crate term_size; +``` + +To get the dimensions of your terminal window, simply use the following: + +```rust +fn main() { + if let Some((w, h)) = term_size::dimensions() { + println!("Width: {}\nHeight: {}", w, h); + } else { + println!("Unable to get term size :(") + } +} +``` + +## License + +Copyright Benjamin Sago, Kevin Knapp, and `term_size` 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. + +## Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request :D + +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. |