README 2.3 KB
Newer Older
Nikodemus Siivola's avatar
Nikodemus Siivola committed
1 2
Alexandria is a collection of portable public domain utilities that
meet the following constraints:
Nikodemus Siivola's avatar
Nikodemus Siivola committed
3

Nikodemus Siivola's avatar
Nikodemus Siivola committed
4 5 6 7 8 9 10 11 12 13 14 15 16
 * Utilities, not extensions: Alexandria will not contain conceptual
   extensions to Common Lisp, instead limiting itself to tools and
   utilities that fit well within the framework of standard ANSI
   Common Lisp. Test-frameworks, system definitions, logging
   facilities, serialization layers, etc. are all outside the scope of
   Alexandria as a library, though well within the scope of Alexandria
   as a project.

 * Conservative: Alexandria limits itself to what project members
   consider conservative utilities. Alexandria does not and will not
   include anaphoric constructs, loop-like binding macros, etc.

 * Portable: Alexandria limits itself to portable parts of Common
Michael Stevens's avatar
Michael Stevens committed
17
   Lisp. Even apparently conservative and useful functions remain
Nikodemus Siivola's avatar
Nikodemus Siivola committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
   outside the scope of Alexandria if they cannot be implemented
   portably. Portability is here defined as portable within a
   conforming implementation: implementation bugs are not considered
   portability issues.

Homepage:

  http://common-lisp.net/project/alexandria/

Mailing lists:

  http://lists.common-lisp.net/mailman/listinfo/alexandria-devel
  http://lists.common-lisp.net/mailman/listinfo/alexandria-cvs

Repository:

Philipp Marek's avatar
Philipp Marek committed
34
  git://gitlab.common-lisp.net/alexandria/alexandria.git
Nikodemus Siivola's avatar
Nikodemus Siivola committed
35 36 37 38 39 40 41 42 43

Documentation:

  http://common-lisp.net/project/alexandria/draft/alexandria.html

  (To build docs locally: cd doc && make html pdf info)

Patches:

Philipp Marek's avatar
Philipp Marek committed
44 45
  Patches are always welcome! Please prepare pull requests in
  gitlab, though we also can pull branches off github.
Nikodemus Siivola's avatar
Nikodemus Siivola committed
46 47 48 49 50

  Patches should include a commit message that explains what's being
  done and /why/, and when fixing a bug or adding a feature you should
  also include a test-case.

Philipp Marek's avatar
Philipp Marek committed
51 52
Versioning & Changes:

Philipp Marek's avatar
Philipp Marek committed
53 54 55 56 57 58 59 60
  Be advised that the ALEXANDRIA-1 package is frozen; there are so many 
  existing users that any newly exported symbols are likely to break
  someone's code.
  For that reason an ALEXANDRIA-2 package is now open for additions;
  to make switching over easier it will include all the symbols from
  ALEXANDRIA-1 as well [just change your (:USE ALEXANDRIA) to 
  (:USE ALEXANDRIA-2) to get the new functions in your package].

Philipp Marek's avatar
Philipp Marek committed
61 62
  Alexandria will be running 1.x version numbers until ALEXANDRIA-2 is
  frozen as well; then a 2.0.0 will be released.