Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples cleanup #225

Merged
merged 2 commits into from
Sep 17, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion crossterm_cursor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ My first recommendation is to use the [command API](https://timonpost.github.io/
Because it is more convenient, faster, and easier to use.

## Examples
The [examples](./examples) folder has more complete and verbose examples.
The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.

```rust
use crossterm_cursor::cursor;
Expand Down
144 changes: 0 additions & 144 deletions crossterm_cursor/examples/cc_cursor.rs

This file was deleted.

2 changes: 1 addition & 1 deletion crossterm_input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ These are the features of this crate:
- RawScreen (from `crossterm_screen`)

## Examples
The [examples](./examples) folder has more complete and verbose examples.
The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.

_Simple Readings_
```rust
Expand Down
26 changes: 0 additions & 26 deletions crossterm_input/examples/ci_input.rs

This file was deleted.

133 changes: 0 additions & 133 deletions crossterm_input/examples/ci_key_events.rs

This file was deleted.

2 changes: 1 addition & 1 deletion crossterm_input/src/input/input.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ impl TerminalInput {
self.input.read_async()
}

/// Read the input asynchronously until a certain character is hit, which means that input events are gathered on the background and will be queued for you to read.
/// Read the input asynchronously until a certain delimiter (character as byte) is hit, which means that input events are gathered on the background and will be queued for you to read.
///
/// If you want a blocking or less resource consuming read to happen, use `read_sync()`. This will leave alone the background thread and queues and will be a blocking read.
///
Expand Down
4 changes: 2 additions & 2 deletions crossterm_screen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In case you are wondering what 'alternate' or 'raw' screen is, you could checkou
## Getting Started

This documentation is only for `crossterm_screen` version `0.2`.
Also, check out the [examples](./examples) folders with detailed examples for all functionality of this crate
Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate
and the [book](https://timonpost.github.io/crossterm/docs/screen.html) for more information about how to use the alternate or raw screen options.

Add the `crossterm_screen` package to your `Cargo.toml` file.
Expand Down Expand Up @@ -81,7 +81,7 @@ Planned features:
- make is possible to switch between multiple buffers.

## Examples
The [examples](./examples) folder has more complete and verbose examples.
The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.

## Tested terminals
- Windows Powershell
Expand Down
10 changes: 0 additions & 10 deletions crossterm_screen/examples/cs_alternate_screen.rs

This file was deleted.

12 changes: 0 additions & 12 deletions crossterm_screen/examples/cs_raw_mode.rs

This file was deleted.

2 changes: 1 addition & 1 deletion crossterm_style/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ These are the features of this crate:
- Text Attributes: bold, italic, underscore and crossed word and [more](https://timonpost.github.io/crossterm/docs/styling.html#attributes) (Windows 10 and UNIX only)

## Examples
The [examples](./examples) folder has more complete and verbose examples.
The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.

_style text with attributes_
```rust
Expand Down
Loading