From 9da970f1f44f19432680e255f91f73fbb8fbe3c8 Mon Sep 17 00:00:00 2001 From: Benedikt Peetz Date: Sun, 16 Feb 2025 10:10:07 +0100 Subject: chore(crates/termsize): Vendor --- crates/termsize/README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 crates/termsize/README.md (limited to 'crates/termsize/README.md') diff --git a/crates/termsize/README.md b/crates/termsize/README.md new file mode 100644 index 0000000..27b7869 --- /dev/null +++ b/crates/termsize/README.md @@ -0,0 +1,49 @@ + + +# termsize + +[![CI](https://github.com/softprops/termsize/actions/workflows/ci.yml/badge.svg)](https://github.com/softprops/termsize/actions/workflows/ci.yml) +[![Crates.io](https://img.shields.io/crates/v/termsize.svg)](https://crates.io/crates/termsize) + +> because terminal size matters + +Termsize is a rust crate providing a multi-platform interface for resolving +your terminal's current size in rows and columns. On most unix systems, this is similar invoking the [stty(1)](http://man7.org/linux/man-pages/man1/stty.1.html) program, requesting the terminal size. + + +## [Documentation](https://softprops.github.com/termsize) + +## install + +run `cargo add termsize` in your terminal or add the following to your `Cargo.toml` file + +```toml +[dependencies] +termsize = "0.1" +``` + +## usage + +Termize provides one function, `get`, which returns a `termsize::Size` struct +exposing two fields: `rows` and `cols` representing the number of rows and columns +a a terminal's stdout supports. + +```rust +pub fn main() { + termsize::get().map(|{ rows, cols }| { + println!("rows {} cols {}", size.rows, size.cols) + }); +} +``` + +Doug Tangren (softprops) 2015-2024 \ No newline at end of file -- cgit 1.4.1