README.md

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