From 0ebc0b7412d811b0865080573555100649a068fc Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Sun, 20 Dec 2015 18:17:06 +0100
Subject: Add content, customize theme

---
 docs/quickstart.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 docs/quickstart.md

(limited to 'docs/quickstart.md')

diff --git a/docs/quickstart.md b/docs/quickstart.md
new file mode 100644
index 0000000..a5dd19f
--- /dev/null
+++ b/docs/quickstart.md
@@ -0,0 +1,41 @@
+gocryptfs Quickstart
+====================
+
+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=$HOME
+
+Download
+-------
+
+	$ go get -d github.com/rfjakob/gocryptfs
+
+Compile
+-------
+
+	$ ~/src/github.com/rfjakob/gocryptfs/build.bash
+	$ mkdir -p ~/bin && cp ~/src/github.com/rfjakob/gocryptfs/gocryptfs ~/bin
+
+Create and Mount Filesystem
+---------------------------
+
+	$ mkdir cipher plain
+	$ ~/bin/gocryptfs -init cipher
+	  [...]
+	$ ~/bin/gocryptfs cipher plain
+	  [...]
+	$ echo test > plain/test.txt
+	$ ls cipher
+	  gocryptfs.conf  gocryptfs.diriv  ZSuIZVzYDy5-TbhWKY-ciA==
+
-- 
cgit v1.2.3