README.md

   1 # Tutil
   2
   3 [![Travis CI][travis-ci-badge]][travis-ci]
   4 [![Coveralls][coveralls-badge]][coveralls]
   5 [![Crates.io][crates-io-badge]][crates-io]
   6 [![Chat Room][chat-room-badge]][chat-room]
   7 [![License][license-badge]][license]
   8
   9 Tutil is a toolbox for developing command line applications in Rust, influenced
  10 by the [TTY library][tty] for Ruby which intends to reach feature parity with
  11 the majority of TTY's features to the extent that is practical in addition to
  12 having an extensive and thorough test suite.
  13
  14 Tutil intends to support Linux, BSD, macOS (formerly known as OS X) and Windows.
  15 However, in this early stage of development, Tutil in its entirety probably only
  16 works on Linux.
  17
  18 The stable documentation can by accessed [here](https://beta.docs.rs/tutil).
  19
  20 ## Features
  21
  22 Implemented features will be marked with a tick (✔) and unimplemented features
  23 will be marked with a cross (✗).
  24
  25 - Terminal output colourisation. ✔
  26 - Terminal output paging. ✗
  27 - Terminal ASCII and Unicode tables. ✗
  28 - System detection utilities. ✗
  29 - Command detection utilities. ✗
  30 - Text manipulation (wrapping and truncation). ✗
  31 - Terminal progress bars. ✗
  32 - Terminal spinners. ✗
  33 - User input prompts. ✗
  34 - Windows support. ✗
  35
  36 There is a [tracking issue][ti] for these which may be more up-to-date.
  37
  38 ## Installation
  39
  40 Add the following to your `Cargo.toml` under the dependencies section:
  41
  42 ```toml
  43 [dependencies]
  44 tutil = "^0.1.0"
  45 ```
  46
  47 <!-- Links -->
  48 [ti]: https://github.com/SShrike/tutil/issues/1
  49 [tty]: http://peter-murach.github.io/tty/
  50 <!-- Badge links and SVGs -->
  51 [travis-ci]: https://travis-ci.org/SShrike/tutil
  52 [travis-ci-badge]: https://img.shields.io/travis/SShrike/tutil.svg
  53 [coveralls]: https://coveralls.io/github/SShrike/tutil
  54 [coveralls-badge]: https://img.shields.io/coveralls/SShrike/tutil.svg
  55 [crates-io]: https://crates.io/crates/tutil
  56 [crates-io-badge]: https://img.shields.io/crates/v/tutil.svg
  57 [chat-room]: https://vector.im/beta/#/room/#tutil:matrix.org
  58 [chat-room-badge]: https://img.shields.io/badge/chat-%23tutil%3Amatrix.org-00B4B7.svg
  59 [license]: https://www.mozilla.org/en-GB/MPL/2.0/
  60 [license-badge]: https://img.shields.io/crates/l/tutil.svg