Skip to content

Commit

Permalink
Add definition of CLI to Readme
Browse files Browse the repository at this point in the history
Fixes #4
  • Loading branch information
killercup committed Mar 9, 2018
1 parent 483da34 commit 5ed5e52
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,18 @@ Let's make this a true statement:

Rust makes writing crossplatform, tested, modern command line applications frictionless
while incorporating industry best practices and providing great documentation.

## What's a CLI?

For our intends and puposes, a CLI is any program that

* Launches in a terminal
* Accepts configuration from various sources, such as command line arguments, environment variables, or configuration files
* Runs to completion with minimal/no user interaction
* Accepts input from `stdin`, files, or network
* Performs processing on some input (files, network, `stdin`) based on the configuration specified
* Communicates via standard outputs (files, network, `std{out,err}`)

(We [specifically][i4] don't want to focus on "TUI" apps right now.)

[i4]: https://github.com/rust-lang-nursery/cli-wg/issues/4

0 comments on commit 5ed5e52

Please sign in to comment.