[crypticl-cvs] CVS update: crypticl/doc/README
Taale Skogan
tskogan at common-lisp.net
Sat Oct 1 16:52:19 UTC 2005
Update of /project/crypticl/cvsroot/crypticl/doc
In directory common-lisp.net:/tmp/cvs-serv2951
Modified Files:
README
Log Message:
Minor Format changes.
Date: Sat Oct 1 18:52:19 2005
Author: tskogan
Index: crypticl/doc/README
diff -u crypticl/doc/README:1.5 crypticl/doc/README:1.6
--- crypticl/doc/README:1.5 Thu Nov 25 22:56:49 2004
+++ crypticl/doc/README Sat Oct 1 18:52:18 2005
@@ -2,7 +2,8 @@
Crypticl is a library of cryptographic functions written in Common Lisp. The
goal is to provide flexible, high level cryptographic abstractions on top of
-a kernel of core cryptographic primitives. It is distributed under a MIT-style license (see the LICENSE file).
+a kernel of core cryptographic primitives. It is distributed under a MIT-style
+license (see the LICENSE file).
The library will be limited to common, secure algorithms and not try to
implement all available cryptographic algorithms. Hence AES is included and
@@ -12,23 +13,28 @@
http://common-lisp.net/project/crypticl/
INSTALL
-The library can be loaded by loading the file "load.lisp". This file
- will load the library and run unit tests.
+The library can be loaded by loading the file "load.lisp". This file will load
+the library and run unit tests.
-ex: (load "C:\\crypticl\\src\\load")
+example: (load "C:\\crypticl\\src\\load")
-The library has only been tested with Allegro 6.2 and may by oversight still
-contain some Allegro specific functions, but the bulk of the code should work
-on all Common Lisp implementations.
+The library has only been tested with Allegro 6.2 under Windows and may
+contain some Allegro specific functions, but the bulk of the code is portable
+to all Common Lisp implementations.
DOCUMENTATION
See the user guide in the file USERGUIDE.
DEVELOPERS
-Document changes in the ChangeLog in addition to writing commit messages. Before commiting, check that the library loads correctly into a fresh top level (use (delete-package 'crypticl) and reload) and verify that the unit tests are successful. Tag with V_<major>_<minor>_<num>, like V_0_1_0, V_0_1_1, etc.
+Document changes in the ChangeLog in addition to writing commit messages.
+Before commiting, check that the library loads correctly into a fresh top
+level (use (delete-package 'crypticl) and reload) and verify that the unit
+tests are successful. Tag with V_<major>_<minor>_<num>, like V_0_1_0,
+V_0_1_1, etc.
TODO
-The file TODO is meant as a supplement to the various TODO comments in the source.
+The file TODO is meant as a supplement to the various TODO comments in the
+source.
CHANGELOG
See the file ChangeLog for the project change log.
More information about the Crypticl-cvs
mailing list