aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 6627cb3686d2971c0b7f7f5f4b61d87ed25a568f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Introduction
`RbCmdline` is a simple Ruby library to built command line interface.

# Motivation
Existing Ruby library to build command line interface have complex API and
abuse a of DSL. This library expose a simple API and do not use any DSL.

# Documentation
The [handbook](doc/handbook.md) contains information about various aspects of
the library.

You can also use the [yard](https://yardoc.org) documentation tool to read
code documentation, for example:

    yard doc

# Contact
If you find a bug or have any question, feel free to open a Github issue or to
contact me [by email](mailto:bryan@frimin.fr).

Please note that I do not currently review or accept any contribution.

# License
Released under the ISC license.

Copyright (c) 2020 Bryan Frimin <bryan@frimin.fr>.

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.