Improve spelling
[alexandria.git] / README
blob59e49ab414f0185cd325e43106a2fc731250ce41
1 Alexandria is a collection of portable public domain utilities that
2 meet the following constraints:
4  * Utilities, not extensions: Alexandria will not contain conceptual
5    extensions to Common Lisp, instead limiting itself to tools and
6    utilities that fit well within the framework of standard ANSI
7    Common Lisp. Test-frameworks, system definitions, logging
8    facilities, serialization layers, etc. are all outside the scope of
9    Alexandria as a library, though well within the scope of Alexandria
10    as a project.
12  * Conservative: Alexandria limits itself to what project members
13    consider conservative utilities. Alexandria does not and will not
14    include anaphoric constructs, loop-like binding macros, etc.
16  * Portable: Alexandria limits itself to portable parts of Common
17    Lisp. Even apparently conservative and useful functions remain
18    outside the scope of Alexandria if they cannot be implemented
19    portably. Portability is here defined as portable within a
20    conforming implementation: implementation bugs are not considered
21    portability issues.
23 Homepage:
25   http://common-lisp.net/project/alexandria/
27 Mailing lists:
29   http://lists.common-lisp.net/mailman/listinfo/alexandria-devel
30   http://lists.common-lisp.net/mailman/listinfo/alexandria-cvs
32 Repository:
34   git://common-lisp.net/projects/alexandria/alexandria.git
36 Documentation:
38   http://common-lisp.net/project/alexandria/draft/alexandria.html
40   (To build docs locally: cd doc && make html pdf info)
42 Patches:
44   Patches are always welcome! Please send them to the mailing list as
45   attachments, generated by "git format-patch -1".
47   Patches should include a commit message that explains what's being
48   done and /why/, and when fixing a bug or adding a feature you should
49   also include a test-case.
51   Be advised though that right now new features are unlikely to be
52   accepted until 1.0 is officially out of the door.