README 4.95 KB
Newer Older
1
.. comment: -*- mode:rst; coding:utf-8 -*-
Pascal Bourguignon's avatar
Pascal Bourguignon committed
2 3


4
Informatimago Public Common Lisp Libraries
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
5
============================================================
Pascal Bourguignon's avatar
Pascal Bourguignon committed
6 7


8
common-lisp/
Pascal Bourguignon's avatar
Pascal Bourguignon committed
9

10 11
    The sublibrary systems provided by this library should contain
    only pure conformant Common Lisp packages.
Pascal Bourguignon's avatar
Pascal Bourguignon committed
12

13 14 15 16 17 18 19
    They should compile and run in all Common Lisp compliant
    implementations, and should have make use of no external package
    (eg. compatibility library) and no other (implementation
    dependant) package than COMMON-LISP.  They should not use #+/#- to
    activate or disable implementation specific code. [There remains
    some packages using #+/#- with implementations specific variants,
    we're working on removing these forms].
Pascal Bourguignon's avatar
Pascal Bourguignon committed
20 21


22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
clext/

    Common Lisp Extensions.

    This directory contains Common-Lisp packages that are
    mostly portable, but that use some extensions,
    packages out of the Common-Lisp specifications, like
    GRAY or other portability libraries.


clmisc/

    Miscellaneous Common Lisp packages.


clisp/

    clisp specific packages.


susv3/

44
    POSIX API (clisp specific for now).
45 46 47 48 49


tools/

    Various tools to help developing and compiling these packages.
50
    (Mostly obsolete since the introduction of ASDF and Quicklisp).
51 52


53 54 55 56
rdp/

    Simple Recursive-Descent Parser.

57

58 59 60 61 62 63 64 65 66 67 68 69
objcl/

    Objective-CL reader macros.


small-cl-pgms/

    Various small lisp programs and proof-of-concept demos.
    Those are not gathered with ASDF system definitions.


Repository
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
70
============================================================
71 72

These libraries can be obtained from the `git` repository at
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
73
https://gitlab.com/com-informatimago/com-informatimago/ ::
74

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
75
    git clone https://gitlab.com/com-informatimago/com-informatimago.git informatimago
76 77 78 79 80 81 82 83 84

They're also available thru `quicklisp <http://quicklisp.org/>`_: ::

    (ql:quickload :com.informatimago.common-lisp)
    (ql:quickload :com.informatimago.clext)
    (ql:quickload :com.informatimago.clmisc)
    #+clisp (ql:quickload :com.informatimago.clisp)
    #+clisp (ql:quickload :com.informatimago.susv3)
    (ql:quickload :com.informatimago.rdp)
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
85
    #+(and ccl darwin) (ql:quickload :com.informatimago.objcl)
86

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
87 88
    (ql:quickload :com.informatimago)

89

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
90 91 92
Documentation
============================================================

93 94 95
You may
`browse the documentation <http://www.informatimago.com/develop/lisp/doc/>`_,
or you may also
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
96
`browse the sources at gitlab <https://gitlab.com/com-informatimago/com-informatimago/tree/master>`_.
97 98


Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
99 100 101
Bug Reports & Patches
============================================================

102 103
Bug reports may be `posted on gitlab issues <https://gitlab.com/com-informatimago/com-informatimago/issues>`_, and  `merge requests for patches on gitlab <https://gitlab.com/com-informatimago/com-informatimago/merge_requests>`_.
Alternatively, they may be sent to `the author <mailto:pjb@informatimago.com>`_.
104 105 106


Authors & License
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
107
============================================================
108

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
109
All this code is authored by Pascal J. Bourguignon, apart from:
110

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
111 112
- the system `com.informatimago.lisp-reader.package` which is authored
  by Zach Beane and modified by Pascal J. Bourguignon.
113

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
114 115
- the system `com.informatimago.lispdoc` which is authored by Sven Van
  Caekenberghe and modified by Pascal J. Bourguignon.
116

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
117
All this code is released under the `GNU AFFERO GENERAL PUBLIC LICENSE <http://www.gnu.org/licenses/agpl-3.0.html>`_ apart from:
118

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
119 120 121 122 123 124
- the system `com.informatimago.lisp-reader.package` which is released
  under the `BSD 2-clause license <https://tldrlegal.com/license/bsd-2-clause-license-%28freebsd%29#fulltext>`_. The original parts of the
  `com.informatimago.lisp-reader.package` system are: Copyright (c) 2012
  Zachary Beane <xach@xach.com>, All Rights Reserved

- the `system com.informatimago.lispdoc` which is released under the `LLGPL license <https://tldrlegal.com/license/lisp-lesser-general-public-license#fulltext>`_.
125

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
126 127 128 129
 The original web site referenced from `cliki <http://www.cliki.net/LispDoc>`_
 seems to have disappared (dead
 links), so a tarball containing a copy of the original sources is
 included in the git repository.
130 131


Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
132 133 134
References
============================================================

135 136 137 138 139 140
- AGPL: `http://www.gnu.org/licenses/agpl-3.0.html <http://www.gnu.org/licenses/agpl-3.0.html>`_
- Common Lisp: `http://en.wikipedia.org/wiki/Common_lisp <http://en.wikipedia.org/wiki/Common_lisp>`_
- Common Lisp Wiki: `http://cliki.net <http://cliki.net>`_
- Pascal J. Bourguignon: `mailto:pjb@informatimago.com <mailto:pjb@informatimago.com>`_  `http://www.informatimago.com/ <http://www.informatimago.com/>`_
- Quicklisp: `http://quicklisp.org/ <http://quicklisp.org/>`_
- Zach Beane: `http://xach.com/ <http://xach.com/>`_
141
- Advantages of monolithic version control `https://danluu.com/monorepo/ <https://danluu.com/monorepo/>`_
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
142

143
TODO
Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
144
============================================================
145 146 147 148

- create a library for low level utilities (eg. proper-list-p) that
  are used by several libraries to break circular dependencies.

149

Pascal J. Bourguignon's avatar
Pascal J. Bourguignon committed
150
.. comment : THE END
151