source: cl-darcs/tags/0.1.0/README

Last change on this file was 56, checked in by Magnus Henoch, 16 years ago

List dependencies in README.

File size: 2.5 KB
Line 
1This is cl-darcs, a darcs client written in Common Lisp.  I started
2writing it because the original client requires GHC (the Glasgow
3Haskell Compiler), which is not available on all platforms.
4
5cl-darcs is currently in a very early state of development.
6
7* Usage
8
9At the REPL:
10
11(asdf:oos 'asdf:load-op :cl-darcs)
12(darcs:get-repo "http://path/to/repo" "/local/non-existent/directory/")
13
14Or if you want to select which patches to apply:
15
16(darcs:get-repo "http://path/to/repo" "/local/repo-dir/" :query t)
17
18To pull new patches from a repo (the address from the remote repo is
19optional, as it defaults to where you got the tree from):
20
21(darcs:pull "/local/repo-dir/")
22or
23(darcs:pull "/local/repo-dir/" "http://path/to/repo")
24
25cl-darcs currently doesn't try to merge changes in your local tree
26with patches you pull; you have to do that manually if you want to
27edit files.  For now, you need an external tool to find the local
28changes, e.g:
29
30diff -x _darcs -ru _darcs/pristine/ .
31
32* Configuration
33
34cl-darcs can use an HTTP proxy:
35
36(setf darcs:*http-proxy* "proxy.example.com:3128")
37
38* Known bugs and misfeatures
39
40Above all, cl-darcs is currently a read-only client.  There is no
41support for generating diffs or committing patches.
42
43Some combinations of merger patches are not properly handled.  You
44should be able to get a tree with a real darcs client, and then use
45cl-darcs for pulling new patches.
46
47Repositories can be fetched only from local files and HTTP.
48
49Tags are not faithfully reproduced.
50
51Checkpoints are not used.
52
53* Compatibility
54
55I primarily develop cl-darcs on CLISP, but try to keep it working on
56SBCL as well.  Users of non-Unix systems probably need to change
57MAKE-TEMP-FILE-NAME in util.lisp.
58
59* Dependencies
60
61 - split-sequence: http://www.cl-user.net/asp/libs/split-sequence
62 - Portable AllegroServe: http://portableaserve.sourceforge.net/
63 - trivial-gray-streams:
64   http://www.cl-user.net/asp/libs/trivial-gray-streams
65 - Ironclad: http://www.cl-user.net/asp/libs/ironclad
66 - CL-FAD: http://weitz.de/cl-fad/
67 - For CLISP, you need SB-SHA1: http://www.cliki.net/sb-sha1
68
69All of these are ASDF-INSTALLable.
70
71* License
72
73cl-darcs is covered by the GPL, like the original darcs client.
74ifstar.lisp and inflate.lisp were borrowed from Franz Inc, and are
75public domain and LLGPL, respectively.
76
77* Links
78
79Project page: http://common-lisp.net/project/cl-darcs/
80Mailing list: cl-darcs-devel@common-lisp.net
81              http://common-lisp.net/cgi-bin/mailman/listinfo/cl-darcs-devel
82
83The original darcs: http://www.darcs.net/
84
85
86Local variables:
87mode: outline
88End:
Note: See TracBrowser for help on using the repository browser.