git-annex/doc/install.mdwn
Joey Hess d828988415 proper encrypted keys
For HMAC, using the Data.Digest.Pure.SHA library. I have been avoiding
this library for checksumming generally, since it's (probably) not
as fast as external utilities, but it's fine to use it for HMAC.
2011-04-16 23:02:09 -04:00

30 lines
1.2 KiB
Markdown

## OS-specific instructions
* [[OSX]]
* [[Debian]]
* [[Ubuntu]]
## Generic instructions
To build and use git-annex, you will need:
* `git`: <http://git-scm.com/>
* The Haskell Platform: <http://haskell.org/platform/>
* MissingH: <http://github.com/jgoerzen/missingh/wiki>
* pcre-light: <http://hackage.haskell.org/package/pcre-light>
* utf8-string: <http://hackage.haskell.org/package/utf8-string>
* SHA: <http://hackage.haskell.org/package/SHA>
* TestPack <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/testpack>
* QuickCheck 2 <http://hackage.haskell.org/package/QuickCheck>
* hS3 <http://hackage.haskell.org/package/hS3> (optional, but recommended)
* `uuid`: <http://www.ossp.org/pkg/lib/uuid/>
(or `uuidgen` from util-linux)
* `xargs`: <http://savannah.gnu.org/projects/findutils/>
* `rsync`: <http://rsync.samba.org/>
* `curl` : <http://http://curl.haxx.se/> (optional, but recommended)
* `sha1sum`: <ftp://ftp.gnu.org/gnu/coreutils/> (optional, but recommended)
* `gpg`: <http://gnupg.org/> (optional; needed for encryption)
* [Ikiwiki](http://ikiwiki.info) is needed to build the documentation,
but that will be skipped if it is not installed.
Then just [[download]] git-annex and run: `make; make install`