source: cl-darcs/trunk/README

Last change on this file was 201, checked in by Magnus Henoch, 14 years ago

Mention compilation 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
5* Compiling
6
7If you use CLISP or SBCL, you can use cl-darcs as a standalone
8executable with an interface very similar to the real darcs.  Just
9run:
10
11./configure && make && make install
12
13You can also use cl-darcs from the REPL, by installing it as an ASDF
14system:
15
16ln -s $PWD/cl-darcs.asd /path/to/asdf-systems/
17
18* Usage
19
20See the manual in the doc directory.
21
22* Known bugs and misfeatures
23
24cl-darcs is brittle and might eat your data.  Getting a remote
25repository or pulling patches from it will not affect it; what happens
26with the target repository varies slighly.  Make backups of data you
27care about, and report bugs!
28
29cl-darcs seems to cope well with either just pulling patches from a
30remote source, or just recording patches, but the combination of these
31two activities hasn't been extensively tested.
32
33Some combinations of merger patches are not properly handled.  You
34should be able to get a tree with a real darcs client, and then use
35cl-darcs for pulling new patches.
36
37Repositories can be fetched only from local files and HTTP.  Patches
38can only be applied to local repositories.
39
40Tags are not faithfully reproduced.
41
42Checkpoints are not used.
43
44* Compatibility
45
46cl-darcs works on CLISP and SBCL on Unix-like systems; it has also
47been reported to work on Lispworks.  Getting it to work on other Lisp
48implementations should be simple; grep the code for #+clisp or #+sbcl.
49For other operating systems, modify MAKE-TEMP-FILE-NAME in util.lisp
50accordingly.
51
52* Dependencies
53
54 - split-sequence: http://www.cl-user.net/asp/libs/split-sequence
55 - Drakma: http://weitz.de/drakma/
56 - PURI: http://puri.b9.com/
57 - trivial-gray-streams: http://www.cl-user.net/asp/libs/trivial-gray-streams
58 - Ironclad: http://www.cl-user.net/asp/libs/ironclad
59 - FLEXI-STREAMS: http://weitz.de/flexi-streams/
60 - CL-FAD: http://weitz.de/cl-fad/
61 - CL-PPCRE: http://weitz.de/cl-ppcre/
62 - CL-DIFFLIB: http://www.cliki.net/CL-DIFFLIB
63
64All of these are ASDF-INSTALLable.
65
66* License
67
68cl-darcs is covered by the GPL, like the original darcs client.
69ifstar.lisp and inflate.lisp were borrowed from Franz Inc, and are
70public domain and LLGPL, respectively.
71
72* Links
73
74Project page: http://common-lisp.net/project/cl-darcs/
75Mailing list: cl-darcs-devel@common-lisp.net
76              http://common-lisp.net/cgi-bin/mailman/listinfo/cl-darcs-devel
77
78The original darcs: http://www.darcs.net/
79
80
81Local variables:
82mode: outline
83End:
Note: See TracBrowser for help on using the repository browser.