docs/index.markdown @ d70dd2b9e3c2

I needed **a** **d**amn **opt**ion parsing library.

Adopt is a simple UNIX-style option parser in Common Lisp, heavily influenced by
Python's optparse and argparse.

* **License:** MIT
* **Documentation:** <https://sjl.bitbucket.io/adopt/>
* **Mercurial:** <https://bitbucket.org/sjl/adopt/>
* **Git:** <https://github.com/sjl/adopt/>

Adopt aims to be a simple, robust option parser.  It can automatically print
help information and even generate `man` pages for you.

Adopt is compatible with Quicklisp, but not *in* Quicklisp (yet).  You can clone
the repository into your [Quicklisp local-projects directory][local] for now.

The `adopt` system contains the core API and depends on [Bobbin][] and
[split-sequence][].

The `adopt/test` system contains the test suite, which depends on some other
systems.  You don't need to load this unless you want to run the unit tests.
The tests pass on SBCL, CCL, ECL, and ABCL on Ubuntu 18.04.  Further testing is
welcome.

[local]: https://www.quicklisp.org/beta/faq.html#local-project
[Bobbin]: https://github.com/sjl/bobbin
[split-sequence]: https://www.cliki.net/split-sequence