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, OS X and Windows. However, in this early
  15 stage of development, Tutil probably only works on Linux.
  16
  17 The documentation can by accessed on my [website](https://shrike.me/tutil).
  18
  19 ## Features
  20
  21 Implemented features will be marked with a tick (✔) and unimplemented features
  22 will be marked with a cross (✗).
  23
  24 - Terminal output colourisation. ✔
  25 - Terminal output paging. ✗
  26 - Terminal ASCII and Unicode tables. ✗
  27 - System detection utilities. ✗
  28 - Command detection utilities. ✗
  29 - Text manipulation (wrapping and truncation). ✗
  30 - Terminal progress bars. ✗
  31 - Terminal spinners. ✗
  32 - User input prompts. ✗
  33 - Windows support. ✗
  34
  35 There is a [tracking issue][ti] for these which may be more up-to-date.
  36
  37 ## Installation
  38
  39 Add the following to your `Cargo.toml` under the dependencies section:
  40
  41 ```toml
  42 [dependencies]
  43 tutil = "^0.1.0"
  44 ```
  45
  46 <!-- Links -->
  47 [ti]: https://github.com/SShrike/tutil/issues/1
  48 [tty]: http://peter-murach.github.io/tty/
  49 <!-- Badge links and SVGs -->
  50 [travis-ci]: https://travis-ci.org/SShrike/tutil
  51 [travis-ci-badge]: https://img.shields.io/travis/SShrike/tutil.svg
  52 [coveralls]: https://coveralls.io/github/SShrike/tutil
  53 [coveralls-badge]: https://img.shields.io/coveralls/SShrike/tutil.svg
  54 [crates-io]: https://crates.io/crates/tutil
  55 [crates-io-badge]: https://img.shields.io/crates/v/tutil.svg
  56 [chat-room]: https://vector.im/beta/#/room/#tutil:matrix.org
  57 [chat-room-badge]: https://img.shields.io/badge/chat-%23tutil%3Amatrix.org-00B4B7.svg
  58 [license]: https://www.mozilla.org/en-GB/MPL/2.0/
  59 [license-badge]: https://img.shields.io/crates/l/tutil.svg