summaryrefslogtreecommitdiffstats
path: root/vendor/termize/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/termize/README.md
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/termize/README.md')
-rw-r--r--vendor/termize/README.md51
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
+====
+
+[![Crates.io](https://img.shields.io/crates/v/termize.svg)](https://crates.io/crates/termize) [![Crates.io](https://img.shields.io/crates/d/termize.svg)](https://crates.io/crates/termize) [![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/JohnTitor/termize/blob/master/LICENSE-MIT) [![license](http://img.shields.io/badge/license-Apache2.0-blue.svg)](https://github.com/JohnTitor/termize/blob/master/LICENSE-APACHE) [![Actions](https://github.com/JohnTitor/termize/workflows/CI/badge.svg)](https://github.com/JohnTitor/termize/workflows/CI) [![Cirrus CI](https://api.cirrus-ci.com/github/JohnTitor/termize.svg)](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).