minicrossterm/examples/README.md

This folder contains examples for crossterm and it's the sub-crates.

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}.

Examples, on the different functionalities

• crossterm style
  • color: this is about the styling of the terminal
• crossterm input
  • input: this is about input reading
  • key_events: this is about reading key events
• crossterm screen
  • alternate_screen: this is about switching to an alternate screen buffer
  • raw_screen: this is about enabling raw screen
• crossterm cursor
  • cursor: this is about the actions you can perform with the cursor
• crossterm terminal
  • terminal: this is about the actions you can perform on the terminal

Other

• crossterm: this is about the struct Crossterm
• command: this is about to the command api
• program examples: this folder will contain some real life examples
• command_bar: this is a terminal application where multiple threads write to the output while you can enter commands asynchronously.