Author: mhenoch Date: Mon Feb 26 21:55:18 2007 New Revision: 99 Modified: cl-darcs/trunk/README Log: Update README Modified: cl-darcs/trunk/README ============================================================================== --- cl-darcs/trunk/README (original) +++ cl-darcs/trunk/README Mon Feb 26 21:55:18 2007 @@ -6,52 +6,25 @@ * Usage -At the REPL: - -(asdf:oos 'asdf:load-op :cl-darcs) -(darcs:get-repo "http://path/to/repo" "/local/non-existent/directory/") - -Or if you want to select which patches to apply: - -(darcs:get-repo "http://path/to/repo" "/local/repo-dir/" :query t) - -To pull new patches from a repo (the address from the remote repo is -optional, as it defaults to where you got the tree from): - -(darcs:pull "/local/repo-dir/") -or -(darcs:pull "/local/repo-dir/" "http://path/to/repo") - -When pulling, the new patches will be applied on top of any unrecorded -changes, which has a good chance of not working. - -To record your own changes: - -(darcs:record-changes "/local/repo-dir/" - "Short patch description" - "my-address@example.com" - :now - "Longer, possibly multi-line, description. -Or just NIL.") - -You will be asked about which changes should be recorded. - -* Configuration - -cl-darcs can use an HTTP proxy: - -(setf darcs:*http-proxy* "proxy.example.com:3128") +See the manual in the doc directory. * Known bugs and misfeatures -Above all, cl-darcs is currently a read-only client. There is no -support for generating diffs or committing patches. +cl-darcs is brittle and might eat your data. Getting a remote +repository or pulling patches from it will not affect it; what happens +with the target repository varies slighly. Make backups of data you +care about, and report bugs! + +cl-darcs seems to cope well with either just pulling patches from a +remote source, or just recording patches, but the combination of these +two activities hasn't been extensively tested. Some combinations of merger patches are not properly handled. You should be able to get a tree with a real darcs client, and then use cl-darcs for pulling new patches. -Repositories can be fetched only from local files and HTTP. +Repositories can be fetched only from local files and HTTP. Patches +can only be applied to local repositories. Tags are not faithfully reproduced. @@ -59,9 +32,10 @@ * Compatibility -I primarily develop cl-darcs on CLISP, but try to keep it working on -SBCL as well. Users of non-Unix systems probably need to change -MAKE-TEMP-FILE-NAME in util.lisp. +cl-darcs works on CLISP and SBCL on Unix-like systems. Getting it to +work on other Lisp implementations should be simple; grep the code for +#+clisp or #+sbcl. For other operating systems, modify +MAKE-TEMP-FILE-NAME in util.lisp accordingly. * Dependencies