Update INSTALL file

Streamline the instructions a bit.  Mention the Debian/Ubuntu and
RHEL/CentOS packages for each dependency.
This commit is contained in:
Andrew Ayer
2015-04-24 20:53:19 -07:00
parent 3104508adf
commit 7880b30e8c
2 changed files with 45 additions and 28 deletions

29
INSTALL
View File

@@ -1,23 +1,34 @@
DEPENDENCIES
To build git-crypt, you need:
Debian/Ubuntu package RHEL/CentOS package
-----------------------------------------------------------------------------
Make make make
A C++ compiler (e.g. gcc) g++ gcc-c++
OpenSSL development files libssl-dev openssl-devel
To use git-crypt, you need:
* Git 1.7.2 or newer
* OpenSSL
To build git-crypt, you need a C++ compiler and OpenSSL development
headers.
Debian/Ubuntu package RHEL/CentOS package
-----------------------------------------------------------------------------
Git 1.7.2 or newer git git
OpenSSL openssl openssl
BUILDING GIT-CRYPT
The Makefile is tailored for g++, but should work with other compilers.
Run:
$ make
$ cp git-crypt /usr/local/bin/
$ make install
It doesn't matter where you install the git-crypt binary - choose wherever
is most convenient for you.
To install to a specific location:
$ make install PREFIX=/usr/local
Or, just copy the git-crypt binary to wherever is most convenient for you.
BUILDING A DEBIAN PACKAGE

View File

@@ -1,29 +1,37 @@
Dependencies
------------
### Dependencies
To build git-crypt, you need:
| Debian/Ubuntu package | RHEL/CentOS package
---------------------------|-----------------------|------------------------
Make | make | make
A C++ compiler (e.g. gcc) | g++ | gcc-c++
OpenSSL development files | libssl-dev | openssl-devel
To use git-crypt, you need:
* Git 1.7.2 or newer
* OpenSSL
To build git-crypt, you need a C++ compiler and OpenSSL development
headers.
| Debian/Ubuntu package | RHEL/CentOS package
---------------------------|-----------------------|------------------------
Git 1.7.2 or newer | git | git
OpenSSL | openssl | openssl
Building git-crypt
------------------
### Building git-crypt
The Makefile is tailored for g++, but should work with other compilers.
Run:
make
cp git-crypt /usr/local/bin/
make install
It doesn't matter where you install the git-crypt binary - choose
wherever is most convenient for you.
To install to a specific location:
make install PREFIX=/usr/local
Or, just copy the git-crypt binary to wherever is most convenient for you.
Building A Debian Package
-------------------------
### Building A Debian Package
Debian packaging can be found in the 'debian' branch of the project Git
repository. The package is built using git-buildpackage as follows:
@@ -32,15 +40,13 @@ repository. The package is built using git-buildpackage as follows:
git-buildpackage -uc -us
Installing On Mac OS X
----------------------
### Installing On Mac OS X
Using the brew package manager, simply run:
brew install git-crypt
Experimental Windows Support
----------------------------
### Experimental Windows Support
git-crypt should build on Windows with MinGW, although the build system
is not yet finalized so you will need to pass your own CXX, CXXFLAGS, and