quickstart using precompiled binaries

1 files changed, 43 insertions, 0 deletions

diff --git a/docs/compile.md b/docs/compile.md
new file mode 100644
index 0000000..b79a0d4
--- /dev/null
+++ b/docs/compile.md
@@ -0,0 +1,43 @@
+Compile gocryptfs from Source
+=============================
+
+You need to have the Go runtime and the OpenSSL headers installed to
+compile gocryptfs.
+
+On Fedora,
+
+	$ sudo dnf install golang openssl-devel
+
+On Debian and Ubuntu,
+
+	$ sudo apt-get install golang libssl-dev
+
+Also, GOPATH must be set. Usually it is simply set to the home directory:
+
+	$ export GOPATH=~
+
+Download Source Code
+--------------------
+
+	$ go get -d github.com/rfjakob/gocryptfs
+
+Compile
+-------
+
+	$ ~/src/github.com/rfjakob/gocryptfs/build.bash
+
+If successful, build.bash will copy the gocryptfs binary to ~/bin.
+
+Test
+----
+
+	$ ~/src/github.com/rfjakob/gocryptfs/test.bash
+
+The tests run about 1 minute and should produce the following output:
+
+	ok  	github.com/rfjakob/gocryptfs/cryptfs	1.174s
+	gocryptfs v0.7-15-gf01f599; on-disk format 2
+	ok  	github.com/rfjakob/gocryptfs/integration_tests	12.409s
+
+You can run "test.bash -v" to see the execution of individual tests. Note that
+the tests also check error cases that produce error messages.