Skip to content

Commit

Permalink
Small documentation update.
Browse files Browse the repository at this point in the history
Just to make things look nicer to Github.

2015-07-01  Didier Verna  <didier@didierverna.net>

	* net.didierverna.clon.asd (:net.didierverna.clon): Update the
	long description.
	* README.md: Copy it here.
	* MANIFESTO: Formerly README.
  • Loading branch information
didierverna committed Jul 1, 2015
1 parent 47d4578 commit 5c126d7
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 12 deletions.
File renamed without changes.
16 changes: 16 additions & 0 deletions README.md
@@ -0,0 +1,16 @@
Clon is a library for command-line options management. It is intended to ease
the creation of standalone Common Lisp applications by providing a powerful
and uniform command-line options interface. The most important features of
Clon are the following.

- From the application programmer's point of view: centralized command-line
options specification and management, including automatic generation of help
strings, conversion from command-line / defaults / fallbacks / environment
variables to application-level option values, global or on-demand option
retrieval, and extensibility (the programmer can define his own option
types).

- From the application user's point of view: uniform command-line option
syntax across all Clon applications, customization of the help strings
layout (with optional ISO6429 coloring on terminals that support it),
automatic completion of abbreviated option names and short/long/pack syntax.
27 changes: 15 additions & 12 deletions net.didierverna.clon.asd
Expand Up @@ -33,19 +33,22 @@
:description
"Command-line options management for standalone Common Lisp applications"
:long-description "\
Clon is a library for command-line option management. It is intended to ease
Clon is a library for command-line options management. It is intended to ease
the creation of standalone Common Lisp applications by providing a powerful
and uniform command-line option interface. The most important features of Clon
are the following.
- [from the programmer's point of view] Centralized command-line options
specification and management, including automatic generation of help
strings, conversion from command-line / environment strings to
application-level option values, global or on-demand option retrieval, and
extensibility (the programmer can define his own option types).
- [from the end-user's point of view] Uniform command-line option syntax
across Clon applications, customization of the help strings layout
(with optional ISO6429 coloring on terminals that support it),
possibly abbreviated option calls and short/long syntax."
and uniform command-line options interface. The most important features of
Clon are the following.
- From the application programmer's point of view: centralized command-line
options specification and management, including automatic generation of help
strings, conversion from command-line / defaults / fallbacks / environment
variables to application-level option values, global or on-demand option
retrieval, and extensibility (the programmer can define his own option
types).
- From the application user's point of view: uniform command-line option
syntax across all Clon applications, customization of the help strings
layout (with optional ISO6429 coloring on terminals that support it),
automatic completion of abbreviated option names and short/long/pack syntax."
:author "Didier Verna <didier@didierverna.net>"
:mailto "didier@didierverna.net"
:homepage "http://www.lrde.epita.fr/~didier/software/lisp/clon.php"
Expand Down

0 comments on commit 5c126d7

Please sign in to comment.