Darcs ===== This is the source tree for darcs, a distributed version control system written in Haskell. For more information, visit the darcs web site: http://www.darcs.net Compilation and Installation ============================ Building Darcs requires the cabal package, version 1.6 or higher. The cabal-install package is also recommended. Using GHC 6.10.3 or newer is STRONGLY RECOMMENDED. You can compile darcs with GHC 6.8, but there are several caveats. If you are using 6.8.2 or older, please disable mmap support (pass -f-mmap to cabal install or runghc Setup configure below). Note that the GHC 6.8.2 that ships with Debian Lenny is not affected and it should be safe to keep mmap enabled. It is also recommended to disable use of Hackage zlib when compiling with GHC 6.8.2 (including the Debian Lenny version): pass -f-zlib to cabal. When using zlib, we have seen occasional crashes with error messages like "openBinaryFile: file locked" -- this is a known GHC 6.8.2 bug (and is fixed in GHC 6.8.3). Last, if you are using a 64-bit system, darcs may hang when you exit a pager when compiled with GHC older than 6.10.3. Although this is harmless, it is quite inconvenient. If you have the "cabal-install" package on your system (that is, there is a "cabal" executable in your path), you can use the following command to create an executable in ~/.cabal/bin/darcs (this will also automatically fetch and build dependencies from the Hackage server). $ cabal update $ cabal install Otherwise, if you have the "cabal" package but not the "cabal-install" package, run the following: $ runghc Setup configure $ runghc Setup build $ sudo runghc Setup install You may also omit the last step and copy the darcs executable (found in dist/build/darcs/darcs) to a location of your choosing. More detailed instructions can be found at including instructions on obtaining a copy of cabal-install. Please also note that the cabal-based build by default requires the cURL library (and development headers). If, for some reason, you cannot provide cURL, please pass "-f-curl" to the configure step above. Hacking ======= For more information about darcs hacking and best practices please check the darcs wiki at http://wiki.darcs.net Of particular interest are the following documents: * http://wiki.darcs.net/Development/GettingStarted * http://wiki.darcs.net/Development/FAQ Testing ======= For more information about the test suite, including how to run specific tests please read tests/README.test_maintainers.txt. Happy hacking!