Skip to content
This repository was archived by the owner on Oct 22, 2019. It is now read-only.

Commit 59e07a0

Browse files
authored
Deprecated release (#9)
Signed-off-by: Robert Vojta <[email protected]>
1 parent 1ee2cf8 commit 59e07a0

File tree

4 files changed

+24
-16
lines changed

4 files changed

+24
-16
lines changed

CHANGELOG.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# Version master
1+
# Version 0.3.2
22

3-
- Improve the documentation
3+
- `to_alternate` switch back to main screen if it fails to switch into raw mode ([PR #4](https://github.com/crossterm-rs/crossterm-screen/pull/4))
4+
- Improve the documentation ([PR #5](https://github.com/crossterm-rs/crossterm-screen/pull/5))
45
- Public API
56
- Include the book content in the documentation
6-
- Remove all references to the crossterm book
7-
- New commands introduced
7+
- Remove all references to the crossterm book ([PR #6](https://github.com/crossterm-rs/crossterm-screen/pull/6))
8+
- New commands introduced ([PR #7](https://github.com/crossterm-rs/crossterm-screen/pull/7))
89
- `EnterAlternateScreen`
910
- `LeaveAlternateScreen`
11+
- Sync Windows and UNIX raw mode behavior ([PR #8](https://github.com/crossterm-rs/crossterm-screen/pull/8))
1012

1113
# Version 0.3.1
1214

Cargo.toml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "crossterm_screen"
3-
version = "0.3.1"
3+
version = "0.3.2"
44
authors = ["T. Post"]
55
description = "A cross-platform library for raw and alternate screen."
66
repository = "https://github.com/crossterm-rs/crossterm-screen"
@@ -11,9 +11,12 @@ exclude = ["target", "Cargo.lock"]
1111
readme = "README.md"
1212
edition = "2018"
1313

14+
[badges]
15+
maintenance = { status = "deprecated" }
16+
1417
[dependencies]
15-
crossterm_utils = { version = "0.3.1" }
18+
crossterm_utils = { version = "0.4.0" }
1619

1720
[target.'cfg(windows)'.dependencies]
1821
winapi = { version = "0.3.8", features = ["minwindef", "wincon"] }
19-
crossterm_winapi = { version = "0.2.1" }
22+
crossterm_winapi = { version = "0.3.0" }

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
# Crossterm Screen
44

5+
**The `crossterm_screen` crate is deprecated and no longer maintained. The GitHub repository will
6+
be archived soon. All the code is being moved to the `crossterm`
7+
[crate](https://github.com/crossterm-rs/crossterm). You can learn more in the
8+
[Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265)
9+
issue.**
10+
511
This crate allows you to work with alternate and raw screen cross-platform.
612
It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested
713
see [Tested Terminals](https://github.com/crossterm-rs/crossterm/blob/master/README.md#tested-terminals) for more info)
@@ -36,15 +42,6 @@ fn main() -> Result<()> {
3642
// Do something in the raw mode
3743
} // `_raw` dropped here <- raw mode is disabled
3844
```
39-
40-
## Future
41-
42-
> The `crossterm_screen` crate code will be moved to the `crossterm` crate (it's re-exported there now).
43-
> Date is not set yet, but it doesn't make a lot of sense to start a new project with it. Please, use
44-
> the `crossterm` crate with the `screen` feature enabled.
45-
46-
Issues in this repository are disabled for the same reason. Please, report all issues in the
47-
[crossterm-rs/crossterm](https://github.com/crossterm-rs/crossterm/issues) repository.
4845

4946
## Features
5047

src/lib.rs

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
//! # Screen
44
//!
5+
//! **The `crossterm_screen` crate is deprecated and no longer maintained. The GitHub repository will
6+
//! be archived soon. All the code is being moved to the `crossterm`
7+
//! [crate](https://github.com/crossterm-rs/crossterm). You can learn more in
8+
//! the [Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265)
9+
//! issue.**
10+
//!
511
//! The `crossterm_screen` crate provides the functionality to work with the terminal screen.
612
//!
713
//! This documentation does not contain a lot of examples. The reason is that it's fairly

0 commit comments

Comments
 (0)