Update of /project/crypticl/cvsroot/crypticl/doc In directory common-lisp.net:/tmp/cvs-serv25741/doc Modified Files: ChangeLog README Log Message: New install instructions. Date: Tue Nov 23 22:19:18 2004 Author: tskogan Index: crypticl/doc/ChangeLog diff -u crypticl/doc/ChangeLog:1.6 crypticl/doc/ChangeLog:1.7 --- crypticl/doc/ChangeLog:1.6 Sun Nov 14 20:56:27 2004 +++ crypticl/doc/ChangeLog Tue Nov 23 22:19:17 2004 @@ -1,3 +1,6 @@ +23-11-2004 Tåle Skogan<tasko@frisurf.no> + * doc/README: new install instructions. + 15-11-2004 Tåle Skogan<tasko@frisurf.no> * src/crypticl-package.lisp: place load code in separate file. * src/load.lisp: load function. Index: crypticl/doc/README diff -u crypticl/doc/README:1.2 crypticl/doc/README:1.3 --- crypticl/doc/README:1.2 Mon Sep 20 21:30:33 2004 +++ crypticl/doc/README Tue Nov 23 22:19:18 2004 @@ -2,8 +2,7 @@ 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 an -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 @@ -13,22 +12,23 @@ http://common-lisp.net/project/crypticl/ INSTALL -The library can be loaded by loading the file crypticl-package.lisp. This file - will call a function that loads the library and runs unit tests. The load -function by default assumes that the source is located in the current -directory. The default should be changed to fit applications using the library. +The library can be loaded by loading the file "load.lisp". This file + will load the library and run unit tests. -ex: (load "crypticl-package.lisp") +ex: (load "C:\\crypticl\\src\\load") -The library has only been tested on Allegro 6.2 and may by oversight still +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 platforms. +on 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. + CHANGELOG -See the file CHANGELOG for the project change log. +See the file ChangeLog for the project change log. CREDITS Tage Stabell-Kulø