extern/encfs
1
0
Fork 0
mirror of https://github.com/vgough/encfs.git synced 2024-11-28 10:54:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

INSTALL.md: Convert to markdown and expand

Browse Source
This commit is contained in:
Jakob Unterwurzacher 2015-01-11 21:53:19 +01:00
parent b05872d85d
commit 6b411e60f8
2 changed files with 54 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
INSTALL
View File

@ -1,23 +0,0 @@
Encfs uses the GNU autoconf / automake toolchain to create makefiles.
The configure script is automatically generated, but is part of most EncFS
distributions. If you have a distribution that does not contain the configure
script, then you can generate it by running "autoreconf -if" or by running
"make -f Makefile.dist".
To build encfs, run:
./configure
make
This creates two executables, encfs and encfsctl in the encfs directory. You
can install to in a system directory via "make install". If the default path
(/usr/local) is not where you want things installed, then use the "--prefix"
option to configure to specify the install prefix.
Encfs and encfsctl can also be installed by hand. They need no special
permissions. You may also want the man pages encfs.1 and encfsctl.1.

54
INSTALL.md Normal file
View File

@ -0,0 +1,54 @@
This document provides generic information for compiling EncFS.
If you are looking for specific instructions for your distribution,
take a look at the page
**[Installing EncFS](https://github.com/vgough/encfs/wiki/Installing-Encfs)**
in the wiki.
Compiling EncFS
===============
EncFS uses the GNU autoconf / automake toolchain to create makefiles.
Also, the configure script is automatically generated using autoreconf.
Compiling EncFS is a three-step process:
autoreconf -if
./configure
make
Optional, but strongly recommended, is running the test suite
to verfify that the generated binaries work as expected
(runtime: 20 seconds)
make test
The compilation process creates two executables, encfs and encfsctl in
the encfs directory. You can install to in a system directory via
make install
. If the default path (`/usr/local`) is not where you want things
installed, then use the `--prefix` option to `configure` to specify the
install prefix.
Encfs and encfsctl can also be installed by hand. They need no special
permissions. You may also want the man pages encfs.1 and encfsctl.1.
Dependencies
============
EncFS depends on a number of libraries:
openssl fuse boost-serialization gettext libtool libintl
Compiling on Debian and Ubuntu
==============================
We use Travis CI to automatically build-test every commit:
[![Build Status](https://travis-ci.org/vgough/encfs.svg)](https://travis-ci.org/vgough/encfs)
The [Travis configuration file .travis.yml](.travis.yml) therefore
always contains up-to-date instructions to build EncFS on Ubuntu
(Travis uses Ubuntu build machines).