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

Update README.md

Browse Source 
Grammer mistakes fixed. Added some informations
This commit is contained in:
Timon 2018-01-18 12:39:52 +01:00 committed by GitHub
parent 00a87a27b6
commit 775bd67ab3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,11 +1,8 @@
# Crossterm | crossplatform terminal library written in rust. # Crossterm | crossplatform terminal library written in rust.
Ever got disappointed when a terminal library for rust was only written for unix systems? Ever got disappointed when a terminal library for rust was only written for unix systems? Crossterm provides the same terminal functionality for both windows and unix systems.
Crossterm provides the same terminal functionality for both windows and unix systems.
Crossterm aims to be simple and easy to call in code. Crossterm aims to be simple and easy to call in code. True the simplicity of crossterm you do not have to worry about the platform your working with. You can just call some module and unther water it will check what to do based on the current platform.
True the simplicty of crossterm you do not have to worry about the platform your working with.
You can just call some module and unther water it will check what to do based on the current platform.
## Getting Started ## Getting Started
@ -51,7 +48,7 @@ For detailed examples of all crossterm functionalities check the `./examples/` d
// Or you can print it directly. // Or you can print it directly.
println!("{}", paint("Red font on blue background color").with(Color::Red).on(Color::Blue)); println!("{}", paint("Red font on blue background color").with(Color::Red).on(Color::Blue));
println!("{}", paint("Red font on default background color").with(Color::Red)); println!("{}", paint("Red font on default background color").with(Color::Red));
println!("{}", paint("Default font color and Blue background color").on(Color::Blue)); println!("{}", paint("Default font color on Blue background color").on(Color::Blue));
``` ```
### Cursor ### Cursor
```rust ```rust
@ -81,7 +78,7 @@ For detailed examples of all crossterm functionalities check the `./examples/` d
### Terminal ### Terminal
```rust ```rust
use crossterm_terminal::get; use crossterm_terminal::{get,ClearType};
let mut cursor = get(); let mut cursor = get();
@ -121,7 +118,7 @@ For detailed examples of all crossterm functionalities check the `./examples/` d
- Scrolling - Scrolling
- Size - Size
- Detailed documentation on every item. - Detailed documentation on every item.
- Full examples for every call. - Examples for every client callable code.
## Tested terminals ## Tested terminals
@ -133,15 +130,13 @@ For detailed examples of all crossterm functionalities check the `./examples/` d
- Ubuntu 17.10 - Ubuntu 17.10
The above terminals have been tested. The above terminals have been tested. Crossterm should works also for windows 7, 8 consoles and all ansi supportable consoles.
Crossterm should works also for windows 7, 8 consoles and all ansi suportable consoles.
But these are yet to be tested. But these are yet to be tested.
If you have used this library for an terminal other than the above list without issues feel free to add it to the above list. If you have used this library for an terminal other than the above list without issues feel free to add it to the above list.
## Notice ## Notice
This library is not totaly stable **yet**. There will not be changed mutch in the code design so do not worry to mutch. This library is not totally stable **yet**. There will not be changed mutch in the code design so do not worry to mutch. If there are any changes that affect previous versions I will describe what to change when upgrading crossterm to new version.
If there are any changes that affect previous versions I will describe what to change when upgrading crossterm to new version.
## Todo crossterm 0.2 ## Todo crossterm 0.2
@ -149,22 +144,21 @@ If there are any changes that affect previous versions I will describe what to c
- Inplementing 256 colors for terminals that support those colors. - Inplementing 256 colors for terminals that support those colors.
- Handling key events - Handling key events
- Tests - Tests
- Storing and resetting cursor position.
## Contributing ## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us. If you would like to contribute to crossterm, than please design the code as it is now. Each module contains the same structures so we can easely extend to multible platforms. As you study the code you will quiqly see what the architecture is. Maybe later there will be an documentation for how crossterm is design.
## Versioning ## Versioning
The current version is crossterm 0.1, every merge I do the version go's up like 0.1.0 -> 0.1.1 -> 0.1.2. The current version is crossterm 0.1, every commit I merge the version go's up like 0.1.0 -> 0.1.1 -> 0.1.2.
When new features arive the packages will go up like 0.1 -> 0.2 -> 0.3 When new features arrives the packages will go up like 0.1 -> 0.2 -> 0.3
## Authors ## Authors
* **Timon Post** - *Project Owner* * **Timon Post** - *Project Owner & creator*
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License ## License