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

Add deprecation warning to the book

Browse Source 
Signed-off-by: Robert Vojta <rvojta@me.com>
This commit is contained in:
Robert Vojta 2019-10-02 09:24:52 +02:00
parent f7e4c6a783
commit beb05b4b1e
No known key found for this signature in database
GPG Key ID: 082AAEA8854E3D88
6 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/mdbook/src/SUMMARY.md
View File

@ -1,4 +1,8 @@
# Crossterm # Crossterm
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
This book explains how crossterm works, and how you can use different functionalities. This book explains how crossterm works, and how you can use different functionalities.
We look at how to turn feature flags features on and off, how to style the terminal with colors and attributes, We look at how to turn feature flags features on and off, how to style the terminal with colors and attributes,
how to read user input and how to make using crossterm easier. how to read user input and how to make using crossterm easier.

6
docs/mdbook/src/command.md
View File

@ -1,4 +1,8 @@
# Command API # Command API
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
The command API makes the use of crossterm much easier and offers more control over when and how a command such as moving the cursor is executed. The command API makes the use of crossterm much easier and offers more control over when and how a command such as moving the cursor is executed.
The command API offers: The command API offers:
@ -161,4 +165,4 @@ for y in 0..40 {
} }
stdout.flush(); stdout.flush();
} }
``` ```

3
docs/mdbook/src/feature_flags.md
View File

@ -1,3 +1,6 @@
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
From `crossterm 0.6` you are able to use feature flags. From `crossterm 0.6` you are able to use feature flags.
With feature flags, you can pick the features you want which reduces the size of the library and could prevent you from having unnecessary dependencies. With feature flags, you can pick the features you want which reduces the size of the library and could prevent you from having unnecessary dependencies.

3
docs/mdbook/src/input.md
View File

@ -1,3 +1,6 @@
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
Crossterm provides a way to work with the terminal input. We will not cover the basic usage but instead asynchronous and synchronous reading of input. Crossterm provides a way to work with the terminal input. We will not cover the basic usage but instead asynchronous and synchronous reading of input.
Please check out these [examples](https://github.com/crossterm-rs/crossterm/blob/master/examples/input.rs) for reading a line or a character from the user. Please check out these [examples](https://github.com/crossterm-rs/crossterm/blob/master/examples/input.rs) for reading a line or a character from the user.

5
docs/mdbook/src/screen.md
View File

@ -1,3 +1,6 @@
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
## Screen Buffer ## Screen Buffer
A screen buffer is a two-dimensional array of characters and color data to be output in a console window. A screen buffer is a two-dimensional array of characters and color data to be output in a console window.
A terminal can have multiple of those screen buffers, and the active screen buffer is the one that is displayed on the screen. A terminal can have multiple of those screen buffers, and the active screen buffer is the one that is displayed on the screen.
@ -40,4 +43,4 @@ _example of what I mean_
To start at the beginning of the next line, use `\n\r`. To start at the beginning of the next line, use `\n\r`.
--------------------------------------------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------------------------------------------
More examples could be found [over here](https://github.com/crossterm-rs/crossterm/blob/master/examples/). More examples could be found [over here](https://github.com/crossterm-rs/crossterm/blob/master/examples/).

3
docs/mdbook/src/styling.md
View File

@ -1,5 +1,8 @@
# Styling Module # Styling Module
> **WARNING**: This book is deprecated, no longer maintained and will be
> removed soon.
Crossterm provides options for you to style your text and terminal. Take for example coloring output and applying attributes. Crossterm provides options for you to style your text and terminal. Take for example coloring output and applying attributes.
**Color support** **Color support**