blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Timon 2018-11-25 15:44:06 +01:00 committed by GitHub
parent 099703741e
commit 3a2545d3ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -43,7 +43,7 @@ This crate supports all UNIX and windows terminals down to windows 7 (not all te
## Getting Started ## Getting Started
This documentation is only for Crossterm version `0.5` if you have an older version of Crossterm I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders which detailed examples for all functionality of this crate. This documentation is only for Crossterm version `0.5` if you have an older version of Crossterm I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate.
Add the Crossterm package to your `Cargo.toml` file. Add the Crossterm package to your `Cargo.toml` file.
@ -95,7 +95,6 @@ These are the features from this crate:
- 256 color support (Windows 10 and UNIX only) - 256 color support (Windows 10 and UNIX only)
- RGB support (Windows 10 and UNIX only) - RGB support (Windows 10 and UNIX only)
- Text Attributes like: bold, italic, underscore and crossed word ect (unix only) - Text Attributes like: bold, italic, underscore and crossed word ect (unix only)
- Custom ANSI color code input to set fore- and background color (unix only)
- Terminal - Terminal
- Clearing (all lines, current line, from cursor down and up, until new line) - Clearing (all lines, current line, from cursor down and up, until new line)
- Scrolling (Up, down) - Scrolling (Up, down)
@ -139,8 +138,7 @@ use crossterm::style::{Color, style};
let style1 = style("Some Blue font on Black background").with(Color::Blue).on(Color::Black); let style1 = style("Some Blue font on Black background").with(Color::Blue).on(Color::Black);
let style2 = style("Some Red font on Yellow background").with(Color::Red).on(Color::Yellow); let style2 = style("Some Red font on Yellow background").with(Color::Red).on(Color::Yellow);
/// !! The following code only works for unix based systems !! // attributes are only supported for UNIX terminals.
// some attributes
let normal = style("Normal text"); let normal = style("Normal text");
let bold = style("Bold text").bold(); let bold = style("Bold text").bold();
let italic = style("Italic text").italic(); let italic = style("Italic text").italic();
@ -217,7 +215,6 @@ This module provides the functionalities to work with terminal input.
```rust ```rust
use crossterm::input; use crossterm::input;
// create Screen to wheron the `cursor()` should function.
let mut input = input(); let mut input = input();
match input.read_char() { match input.read_char() {
@ -238,7 +235,6 @@ This module provides the functionalities to work with the terminal in general.
```rust ```rust
use crossterm::terminal::{terminal,ClearType}; use crossterm::terminal::{terminal,ClearType};
// create Screen to wheron the `terminal()` should function.
let mut terminal = terminal(); let mut terminal = terminal();
// Clear all lines in terminal; // Clear all lines in terminal;
@ -300,7 +296,7 @@ I still have some things in mind to implement.
- Handling key events - Handling key events
I want to be able to read key combination inputs. I want to be able to read key combination inputs.
- Tests - Tests
Find a way to test: color output, input, alternate screen, rawscreen Find a way to test: color, alternate screen, rawscreen
## Contributing ## Contributing