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

Improve Markdown table formatting (#647)

Browse Source
This commit is contained in:
Cl00e9ment 2022-04-03 15:02:43 +02:00 committed by GitHub
parent c90f3190df
commit 2e5ba7431f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -134,24 +134,23 @@ version = "0.23"
features = ["event-stream"]
```
| Feature | Description |
| :----- | :----- |
| `event-stream` | `futures::Stream` producing `Result<Event>`.|
| `serde`| Se/dese/rializing of events. |
| Feature | Description |
|:---------------|:---------------------------------------------|
| `event-stream` | `futures::Stream` producing `Result<Event>`. |
| `serde` | Se/dese/rializing of events. |
### Dependency Justification
| Dependency | Used for | Included |
| :----- | :----- | :-----
| `bitflags` | `KeyModifiers`, those are differ based on input.| always
| `parking_lot` | locking `RwLock`s with a timeout, const mutexes. | always
| `libc` | UNIX terminal_size/raw modes/set_title and several other lowlevel functionality. | UNIX only
| `Mio` | event readiness polling, waking up poller | UNIX only
| `signal-hook`| signalhook is used to handle terminal resize SIGNAL with Mio. | UNIX only
| `winapi`| Used for low-level windows system calls which ANSI codes can't replace | windows only
| `futures-core`| For async stream of events | only with `event-stream` feature flag
| `serde`| Se/dese/rializing of events | only with `serde` feature flag
| Dependency | Used for | Included |
|:---------------|:---------------------------------------------------------------------------------|:--------------------------------------|
| `bitflags` | `KeyModifiers`, those are differ based on input. | always |
| `parking_lot` | locking `RwLock`s with a timeout, const mutexes. | always |
| `libc` | UNIX terminal_size/raw modes/set_title and several other lowlevel functionality. | UNIX only |
| `Mio` | event readiness polling, waking up poller | UNIX only |
| `signal-hook` | signalhook is used to handle terminal resize SIGNAL with Mio. | UNIX only |
| `winapi` | Used for low-level windows system calls which ANSI codes can't replace | windows only |
| `futures-core` | For async stream of events | only with `event-stream` feature flag |
| `serde` | Se/dese/rializing of events | only with `serde` feature flag |
### Other Resources

10
docs/CONTRIBUTING.md
View File

@ -39,11 +39,11 @@ _Languages & Frameworks_ -> _Rust_ -> _Rustfmt_ -> _Run rustfmt on save_.
### Max Line Length
| Type | Max line length |
| :--- | ---: |
| Code | 100 |
| Comments in the code | 120 |
| Documentation | 120 |
| Type | Max line length |
|:---------------------|----------------:|
| Code | 100 |
| Comments in the code | 120 |
| Documentation | 120 |
100 is the [`max_width`](https://github.com/rust-lang/rustfmt/blob/master/Configurations.md#max_width)
default value.

12
examples/README.md
View File

@ -12,12 +12,12 @@ The examples are compatible with the latest release.
│   └── event-*
│   └── stderr
```
| File Name | Description | Topics
| :------- | :------- | :------- |
| `examples/interactive-test` | interactive, walk trough, demo | cursor, style, event
| `event-*`| event reading demos | (async) event reading
| `stderr` | crossterm over stderr demo | raw mode, alternate screen, custom output
| `is_tty` | Is this instance a tty ? | tty |
| File Name | Description | Topics |
|:----------------------------|:-------------------------------|:------------------------------------------|
| `examples/interactive-test` | interactive, walk trough, demo | cursor, style, event |
| `event-*` | event reading demos | (async) event reading |
| `stderr` | crossterm over stderr demo | raw mode, alternate screen, custom output |
| `is_tty` | Is this instance a tty ? | tty |
## Run examples