Merge branch 'master' of https://github.com/TimonPost/crossterm
This commit is contained in:
TimonPost
commit
606d816c30
68
README.md
68
README.md
@ -1,4 +1,4 @@
|
||||
[](https://crates.io/crates/crossterm) | [](./LICENSE) | [](https://docs.rs/crossterm/) | [Examples](link_to_examples) | [Changelog](link_to_change_log) | [Release Nodes](link_to_release_nodes)
|
||||
[](https://crates.io/crates/crossterm) | [](./LICENSE) | [](https://docs.rs/crossterm/) | [Examples](https://github.com/TimonPost/crossterm/tree/master/examples) | [Changelog](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) | [Release Nodes](https://github.com/TimonPost/crossterm/tree/master/docs)
|
||||
|----|----|----|----|----|----
|
||||
|
||||
Ever got disappointed when a terminal library for rust was only written for unix systems?
|
||||
@ -11,28 +11,28 @@ You can just call whatever action you want and underwater it will check what to
|
||||
This crate supports all unix and windows terminals down to windows XP (not not all terminals are tested see 'Tested Terminals' for more info)
|
||||
|
||||
### Table of contents:
|
||||
- [Getting started](link)
|
||||
- [Usefull links](link)
|
||||
- [Features](link)
|
||||
- [Examples]()
|
||||
- [Croossterm Wrapper]()
|
||||
- [Styling](link)
|
||||
- [Cursor](link)
|
||||
- [Terminal](link)
|
||||
- [Tested Terminals](link)
|
||||
- [How it works](link)
|
||||
- [Notice](link)
|
||||
- [Todo](link)
|
||||
- [Contributing](link)
|
||||
- [Authors](link)
|
||||
- [License](link)
|
||||
- [Getting started](https://github.com/TimonPost/crossterm#getting-started)
|
||||
- [Usefull links](https://github.com/TimonPost/crossterm#useful-links)
|
||||
- [Features](https://github.com/TimonPost/crossterm#features)
|
||||
- [Examples](https://github.com/TimonPost/crossterm#examples)
|
||||
- [Crossterm Wrapper](https://github.com/TimonPost/crossterm#crossterm-wrapper--see-more)
|
||||
- [Styling](https://github.com/TimonPost/crossterm#styled-font--see-more)
|
||||
- [Cursor](https://github.com/TimonPost/crossterm#cursor--see-more)
|
||||
- [Terminal](https://github.com/TimonPost/crossterm#terminal--see-more)
|
||||
- [Tested Terminals](https://github.com/TimonPost/crossterm#tested-terminals)
|
||||
- [How it works](https://github.com/TimonPost/crossterm#how-it-works)
|
||||
- [Notice](https://github.com/TimonPost/crossterm#notice)
|
||||
- [Todo](https://github.com/TimonPost/crossterm#todo)
|
||||
- [Contributing](https://github.com/TimonPost/crossterm#contributing)
|
||||
- [Authors](https://github.com/TimonPost/crossterm#authors)
|
||||
- [License](https://github.com/TimonPost/crossterm#license)
|
||||
|
||||
## IMPORTANT When updating to version `0.2.3`
|
||||
Version `0.2.3` of Crossterm will have API braking changes. If you are reading this and you version whas autmaticly incremented to the new version, there will be some broken code. An Quiqe solution? no unless you did not used this crate that much. If it is important to keep running you code and you don't want to spend some time to fix the errors I recomend you to keep using version `0.2.2` because in version `0.2.3` alternate screen and some other features are introduced. And if you are not using any of these feature just downgrade. If however you want to have the newest version you can check the [upgrade manual](link) on how to upgrade to te new version. Check [changelog](link) why thise Api braking changes where nessairly.
|
||||
Version `0.2.3` of Crossterm will have API braking changes. If you are reading this and you version whas autmaticly incremented to the new version, there will be some broken code. An Quiqe solution? no unless you did not used this crate that much. If it is important to keep running you code and you don't want to spend some time to fix the errors I recomend you to keep using version `0.2.2` because in version `0.2.3` alternate screen and some other features are introduced. And if you are not using any of these feature just downgrade. If however you want to have the newest version you can check the [upgrade manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) on how to upgrade to te new version. Check [release node](https://github.com/TimonPost/crossterm/blob/master/docs/ReleaseNotesVersion%200.2.3.md) why thise Api braking changes where nessairly.
|
||||
|
||||
## Getting Started
|
||||
|
||||
This documentation is only for Crossterm version `0.2.3` if you have an older version of Crossterm I suggest you to check the [Upgrade Manual](link_to_manual) for more infomation about how to upgrade to an newer version or checkout the [README.md](link_to_backup_readme) from the previous versions. Also you could take a look at the [examples](link) from the previous versions of Crossterm.
|
||||
This documentation is only for Crossterm version `0.2.3` if you have an older version of Crossterm I suggest you to check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) for more infomation about how to upgrade to an newer version or checkout the [README.md](https://github.com/TimonPost/crossterm/tree/master/docs) from the previous versions. Also you could take a look at the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) wich have examples from the previous versions of Crossterm.
|
||||
|
||||
|
||||
Add the Crossterm package to your `Cargo.toml` file.
|
||||
@ -60,20 +60,17 @@ use self::crossterm::terminal::*;
|
||||
|
||||
- Code documentation:
|
||||
version [0.1.0](https://docs.rs/crossterm/0.1.0/crossterm/),
|
||||
version [0.2.0](https://docs.rs/crossterm/0.2.0/crossterm/),
|
||||
version [0.2.1](https://docs.rs/crossterm/0.2.1/crossterm/)
|
||||
[0.2.0](https://docs.rs/crossterm/0.2.0/crossterm/),
|
||||
[0.2.1](https://docs.rs/crossterm/0.2.1/crossterm/)
|
||||
and [0.2.3](link)
|
||||
|
||||
<<<<<<< HEAD
|
||||
- Code functionalities Examples:
|
||||
version [0.1.0](link_examples_01),
|
||||
version [0.2.0](link_examples_02),
|
||||
version [0.2.1](link_examples_03)
|
||||
and version [0.2.3](link_examples_04)
|
||||
- Code Examples:
|
||||
version [0.1.0](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.1.0),
|
||||
[0.2.0](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.2.0),
|
||||
[0.2.1](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.2.1)
|
||||
and [0.2.3](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.2.3)
|
||||
|
||||
- [Cargo Page](https://crates.io/crates/crossterm)
|
||||
- [Examples for specific versions](link_to_specific_version)
|
||||
- [Real life examples](example_link)
|
||||
- [Real life examples](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.2.3/program_examples)
|
||||
|
||||
# Features
|
||||
These are the fatures from this crate:
|
||||
@ -107,7 +104,7 @@ These are the fatures from this crate:
|
||||
|
||||
For detailed examples of all Crossterm functionalities check the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) directory.
|
||||
|
||||
### Crossterm wrapper | [see more](example_link)
|
||||
### Crossterm wrapper | [see more](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/crossterm_type/mod.rs)
|
||||
This is a wrapper for the modules crossterm provides. This is introduced to mange the [`Context`](link_to_context) for the user.
|
||||
```
|
||||
let crossterm = Crossterm::new();
|
||||
@ -122,7 +119,7 @@ crossterm.write("some text");
|
||||
// print some styled font.
|
||||
println!("{}", crossterm.paint("Red font on blue background").with(Color::Red).on(Color::Blue));
|
||||
```
|
||||
### Styled font | [see more](example_link)
|
||||
### Styled font | [see more](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/color/mod.rs)
|
||||
This module provides the functionalities to style the terminal cursor.
|
||||
```rust
|
||||
use crossterm::style::{Color};
|
||||
@ -163,7 +160,7 @@ println!("{}", crossterm.paint("Reversed color").reverse());
|
||||
println!("{}", crossterm.paint("Dim text color").dim());
|
||||
println!("{}", crossterm.paint("Crossed out font").crossed_out());
|
||||
```
|
||||
### Cursor | [see more](example_link)
|
||||
### Cursor | [see more](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/cursor/mod.rs)
|
||||
This module provides the functionalities to work with the terminal cursor.
|
||||
|
||||
```rust
|
||||
@ -217,7 +214,7 @@ cursor.blink(true)
|
||||
|
||||
```
|
||||
|
||||
### Terminal | [see more](example_link)
|
||||
### Terminal | [see more](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/terminal/terminal.rs)
|
||||
This module provides the functionalities to work with the terminal in general.
|
||||
|
||||
```rust
|
||||
@ -262,7 +259,7 @@ terminal.write("Some text\n Some text on new line");
|
||||
println!("{}", terminal.paint("x").with(Color::Red).on(Color::Blue));
|
||||
```
|
||||
|
||||
Check these links: [AlternateScreen](link) and [RawScreen](link) for information about how to work with these features.
|
||||
Check these links: [AlternateScreen](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/terminal/alternate_screen.rs) and [RawScreen](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/terminal/raw_mode.rs) for information about how to work with these features.
|
||||
|
||||
## Tested terminals
|
||||
|
||||
@ -282,9 +279,8 @@ Crossterm is using ANSI escape codes by default for both unix and windows system
|
||||
But for Windows it is a bit more complicater since Windows versions 8 or lower are not supporting ANSI escape codes. This is why we use WinApi for those machines. For Windows 10 ANSI codes will be the default.
|
||||
|
||||
## Notice
|
||||
<<<<<<< HEAD
|
||||
This libary is not stable yet but I expect it ot not to change that mutch anymore.
|
||||
And if there are any changes that affect previous versions I will [describe](link_to_upgrade_manual) what to change when upgrading Crossterm to an newer version.
|
||||
And if there are any changes that affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) what to change when upgrading Crossterm to an newer version.
|
||||
|
||||
## Todo
|
||||
I still have some things in mind to implement.
|
||||
|
||||
@ -4,8 +4,8 @@ Because you will have some work to get to the new version of crossterm depending
|
||||
But if this is the firsttime you are using this crate I highly recommend you to switch to the new version `0.2.3`.
|
||||
|
||||
Some Features crossterm 0.2.3
|
||||
- [Alternate screen](LINK) for windows and unix systems.
|
||||
- [Raw screen](LINK) for unix and windows systems [Issue 5](https://github.com/TimonPost/crossterm/issues/5)..
|
||||
- Alternate Screen for windows and unix systems.
|
||||
- Raw screen for unix and windows systems [Issue 5](https://github.com/TimonPost/crossterm/issues/5)..
|
||||
- Hiding an showing the cursor.
|
||||
- Control over blinking of the terminal cursor (only some terminals are supporting this).
|
||||
- The terminal state will be set to its original state when process ends [issue7](https://github.com/TimonPost/crossterm/issues/7).
|
||||
@ -38,12 +38,12 @@ With these modes you can easier design the terminal screen.
|
||||
- Hiding and showing terminal cursor
|
||||
- Enable or disabling blinking of the cursor for unix systems (this is not widely supported)
|
||||
- Restoring the terminal to original modes.
|
||||
- Added a [wrapper](linktocrosstermtype) for managing all the functionalities of crossterm `Crossterm`.
|
||||
- Added a [wrapper](https://github.com/TimonPost/crossterm/blob/master/src/shared/crossterm.rs) for managing all the functionalities of crossterm `Crossterm`.
|
||||
- Exit the current running process
|
||||
|
||||
## Examples
|
||||
Added [examples](link_to_examples) for each version of the crossterm version.
|
||||
Also added a folder with some [real life examples](link_to_realive_examples).
|
||||
Added [examples](https://github.com/TimonPost/crossterm/tree/master/examples) for each version of the crossterm version.
|
||||
Also added a folder with some [real life examples](https://github.com/TimonPost/crossterm/tree/master/examples/Crossterm%200.2.3/program_examples).
|
||||
|
||||
## Context
|
||||
|
||||
@ -77,7 +77,7 @@ When this `Context` goes out of scope all changes made will be undone.
|
||||
Also is this `Context` is a wrapper for access to the current console screen.
|
||||
|
||||
Because Crossterm needs access to the above to types quite often I have chosen to add those two in one struct called `Context` so that this type could be shared throughout library.
|
||||
Check this link for more info: [cleanup of rust codr](https://stackoverflow.com/questions/48732387/how-can-i-run-clean-up-code-in-a-rust-library).
|
||||
Check this link for more info: [cleanup of rust code](https://stackoverflow.com/questions/48732387/how-can-i-run-clean-up-code-in-a-rust-library).
|
||||
More info over writing to alternate screen buffer on windows and unix see this [link](https://github.com/TimonPost/crossterm/issues/17)
|
||||
|
||||
__Now the user has to pass an context type to the modules of Crossterm like this:__
|
||||
@ -98,7 +98,7 @@ Because this looks a little odd I will provide a type withs will manage the `Con
|
||||
|
||||
### Alternate screen
|
||||
When you want to switch to alternate screen there are a couple of things to keep in mind for it to work correctly.
|
||||
First off some code of how to switch to Alternate screen, for more info check the [alternate screen example](link).
|
||||
First off some code of how to switch to Alternate screen, for more info check the [alternate screen example](https://github.com/TimonPost/crossterm/blob/master/examples/Crossterm%200.2.3/terminal/alternate_screen.rs).
|
||||
|
||||
_Create alternate screen from `Context`_
|
||||
|
||||
@ -120,4 +120,4 @@ _Create alternate screen from `Crossterm`:_
|
||||
|
||||
like demonstrated above, to get the functionalities of `cursor(), color(), terminal()` also working on alternate screen.
|
||||
You need to pass it the same `Context` as you have passed to the previous three called functions,
|
||||
If you don't use the same `Context` in `cursor(), color(), terminal()` than these modules will be using the main screen and you will not see anything at the alternate screen. If you use the [Crossterm](link) type you can get the `Context` from it by calling the crossterm.get_context() whereafter you can create the AlternateScreen from it.
|
||||
If you don't use the same `Context` in `cursor(), color(), terminal()` than these modules will be using the main screen and you will not see anything at the alternate screen. If you use the [Crossterm](https://github.com/TimonPost/crossterm/blob/master/src/shared/crossterm.rs) type you can get the `Context` from it by calling the crossterm.get_context() whereafter you can create the AlternateScreen from it.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user