minicrossterm/examples/README.md

25 lines
2.1 KiB
Markdown
Raw Normal View History

2019-09-17 18:50:39 +10:00
This folder contains examples for crossterm and it's the sub-crates.
2019-09-25 03:45:59 +10:00
**When using a sub-crate instead of the crossterm crate, make sure to change the namespaces in the examples from `crossterm` to `crossterm_{crate_name}`.**
2019-09-17 18:50:39 +10:00
Examples, on the different functionalities
- [crossterm style](https://crates.io/crates/crossterm_style)
2019-09-25 03:45:59 +10:00
- [color](https://github.com/crossterm-rs/crossterm/blob/master/examples/cursor.rs): this is about the styling of the terminal
2019-09-17 18:50:39 +10:00
- [crossterm input](https://crates.io/crates/crossterm_input)
2019-09-25 03:45:59 +10:00
- [input](https://github.com/crossterm-rs/crossterm/blob/master/examples/input.rs): this is about input reading
- [key_events](https://github.com/crossterm-rs/crossterm/blob/master/examples/key_events.rs): this is about reading key events
2019-09-17 18:50:39 +10:00
- [crossterm screen](https://crates.io/crates/crossterm_screen)
2019-09-25 03:45:59 +10:00
- [alternate_screen](https://github.com/crossterm-rs/crossterm/blob/master/examples/alternate_screen.rs): this is about switching to an alternate screen buffer
- [raw_screen](https://github.com/crossterm-rs/crossterm/blob/master/examples/raw_screen.rs): this is about enabling raw screen
2019-09-17 18:50:39 +10:00
- [crossterm cursor](https://crates.io/crates/crossterm_cursor)
2019-09-25 03:45:59 +10:00
- [cursor](https://github.com/crossterm-rs/crossterm/blob/master/examples/cursor.rs): this is about the actions you can perform with the cursor
2019-09-17 18:50:39 +10:00
- [crossterm terminal](https://crates.io/crates/crossterm_terminal)
2019-09-25 03:45:59 +10:00
- [terminal](https://github.com/crossterm-rs/crossterm/blob/master/examples/terminal.rs): this is about the actions you can perform on the terminal
2019-09-17 18:50:39 +10:00
Other
2019-09-25 03:45:59 +10:00
- [crossterm](https://github.com/crossterm-rs/crossterm/blob/master/examples/crossterm.rs): this is about the struct `Crossterm`
- [command](https://github.com/crossterm-rs/crossterm/blob/master/examples/command.rs): this is about to the command api
- [program examples](https://github.com/crossterm-rs/crossterm/tree/master/examples/program_examples): this folder will contain some real life examples
- [command_bar](https://github.com/crossterm-rs/crossterm/tree/master/examples/command_bar): this is a terminal application where multiple threads write to the output while you can enter
2019-09-17 18:50:39 +10:00
commands asynchronously.