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

Deprecated release #10

Merged
merged 7 commits into from
Oct 21, 2019
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# Version master

- Internal refactoring (no breaking changes)
- Removed unsafe `static mut`
- Documentation update
- Remove all references to the crossterm book
- Mouse coordinates synchronized with the cursor (breaking)
# Version 0.5.0

- Internal refactoring ([PR #3](https://github.com/crossterm-rs/crossterm-input/pull/3))
- Removed unsafe `static mut`
- Documentation update
- Remove all references to the crossterm book
- Sync documentation style ([PR #4](https://github.com/crossterm-rs/crossterm-input/pull/4))
- Sync `SyncReader::next()` Windows and UNIX behavior ([PR #5](https://github.com/crossterm-rs/crossterm-input/pull/5))
- Remove all references to the crossterm book ([PR #6](https://github.com/crossterm-rs/crossterm-input/pull/6))
- Mouse coordinates synchronized with the cursor ([PR #7](https://github.com/crossterm-rs/crossterm-input/pull/7))
- Upper/left reported as `(0, 0)`
- Fixed bug that read sync didn't block (Windows)
- AsyncReader produces mouse events (#271)
- One reading thread per application, not per AsyncReader
- Fixed cursor position getting consumed by async reader
- Implemented sync reader for read_char (requires raw mode)
- Added mio for reading from FD and more efficient polling (UNIX only)
- Fixed bug that read sync didn't block (Windows) ([PR #8](https://github.com/crossterm-rs/crossterm-input/pull/8))
- Refactored UNIX readers ([PR #9](https://github.com/crossterm-rs/crossterm-input/pull/9))
- AsyncReader produces mouse events
- One reading thread per application, not per `AsyncReader`
- Cursor position no longer consumed by another `AsyncReader`
- Implemented sync reader for read_char (requires raw mode)
- Fixed `SIGTTIN` when executed under the LLDB
- Added mio for reading from FD and more efficient polling (UNIX only)

## Windows only

Expand Down
11 changes: 7 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "crossterm_input"
version = "0.4.1"
version = "0.5.0"
authors = ["T. Post"]
description = "A cross-platform library for reading userinput."
repository = "https://github.com/crossterm-rs/crossterm-input"
Expand All @@ -11,16 +11,19 @@ exclude = ["target", "Cargo.lock"]
readme = "README.md"
edition = "2018"

[badges]
maintenance = { status = "deprecated" }

[target.'cfg(windows)'.dependencies]
winapi = { version = "0.3.8", features = ["winnt", "winuser"] }
crossterm_winapi = { git = "https://github.com/crossterm-rs/crossterm-winapi.git", branch = "master", version = "0.2.1" }
crossterm_winapi = { version = "0.3.0" }

[target.'cfg(unix)'.dependencies]
libc = "0.2.51"
mio = "0.6.19"

[dependencies]
crossterm_utils = { version = "0.3.1" }
crossterm_screen = { version = "0.3.1" }
crossterm_utils = { version = "0.4.0" }
crossterm_screen = { version = "0.3.2" }
lazy_static = "1.4"
serde = { version = "1.0", features = ["derive"], optional = true }
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

# Crossterm Input

**The `crossterm_input` crate is deprecated and no longer maintained. The GitHub repository will
be archived soon. All the code is being moved to the `crossterm`
[crate](https://github.com/crossterm-rs/crossterm). You can learn more in the
[Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265)
issue.**

This crate allows you to read the user input cross-platform.
It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested
see [Tested Terminals](https://github.com/crossterm-rs/crossterm/blob/master/README.md#tested-terminals) for more info).
Expand All @@ -10,15 +16,6 @@ see [Tested Terminals](https://github.com/crossterm-rs/crossterm/blob/master/REA
directly, but it's **highly recommended** to use the [crossterm](https://crates.io/crates/crossterm) crate with
the `input` feature enabled.

## Future

> The `crossterm_input` crate code will be moved to the `crossterm` crate (it's reexported there now).
> Date is not set yet, but it doesn't make a lot of sense to start a new project with it. Please, use
> the `crossterm` crate with the `input` feature enabled.

Issues in this repository are disabled for the same reason. Please, report all issues in the
[crossterm-rs/crossterm](https://github.com/crossterm-rs/crossterm/issues) repository.

## Features

- Cross-platform
Expand Down
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

//! # Input
//!
//! **The `crossterm_input` crate is deprecated and no longer maintained. The GitHub repository will
//! be archived soon. All the code is being moved to the `crossterm`
//! [crate](https://github.com/crossterm-rs/crossterm). You can learn more in
//! the [Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265)
//! issue.**
//!
//! The `crossterm_input` crate provides a functionality to read the input events.
//!
//! This documentation does not contain a lot of examples. The reason is that it's fairly
Expand Down