1DEPENDENCIES
2
3To build git-crypt, you need:
4
5                                    Debian/Ubuntu package   RHEL/CentOS package
6  -----------------------------------------------------------------------------
7  Make                              make                    make
8  A C++11 compiler (e.g. gcc 4.9+)  g++                     gcc-c++
9  OpenSSL development files         libssl-dev              openssl-devel
10
11
12To use git-crypt, you need:
13
14                                    Debian/Ubuntu package   RHEL/CentOS package
15  -----------------------------------------------------------------------------
16  Git 1.7.2 or newer                git                     git
17  OpenSSL                           openssl                 openssl
18
19Note: Git 1.8.5 or newer is recommended for best performance.
20
21
22BUILDING GIT-CRYPT
23
24Run:
25
26	$ make
27	$ make install
28
29To install to a specific location:
30
31	$ make install PREFIX=/usr/local
32
33Or, just copy the git-crypt binary to wherever is most convenient for you.
34
35
36BUILDING THE MAN PAGE
37
38To build and install the git-crypt(1) man page, pass ENABLE_MAN=yes to make:
39
40	$ make ENABLE_MAN=yes
41	$ make ENABLE_MAN=yes install
42
43xsltproc is required to build the man page.  Note that xsltproc will access
44the Internet to retrieve its stylesheet unless the Docbook stylesheet is
45installed locally and registered in the system's XML catalog.
46
47
48BUILDING A DEBIAN PACKAGE
49
50Debian packaging can be found in the 'debian' branch of the project
51Git repository.  The package is built using git-buildpackage as follows:
52
53	$ git checkout debian
54	$ git-buildpackage -uc -us
55
56
57INSTALLING ON MAC OS X
58
59Using the brew package manager, simply run:
60
61        $ brew install git-crypt
62
63
64EXPERIMENTAL WINDOWS SUPPORT
65
66git-crypt should build on Windows with MinGW, although the build system
67is not yet finalized so you will need to pass your own CXX, CXXFLAGS, and
68LDFLAGS variables to make.  Additionally, Windows support is less tested
69and does not currently create key files with restrictive permissions,
70making it unsuitable for use on a multi-user system.  Windows support
71will mature in a future version of git-crypt.  Bug reports and patches
72are most welcome!
73