From 43905cd94ae34c8cbbccd2ac89ac318fe932b283 Mon Sep 17 00:00:00 2001 From: Damien Goutte-Gattat Date: Sun, 14 Feb 2016 00:06:26 +0100 Subject: [PATCH] Convert README to GitLab Flavored Markdown --- README => README.md | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) rename README => README.md (55%) diff --git a/README b/README.md similarity index 55% rename from README rename to README.md index 32a996c..bf391e3 100644 --- a/README +++ b/README.md @@ -13,20 +13,20 @@ sticks and/or MTP-compliant devices like some smartphones or audio players). The program needs a configuration file (by default, -$XDG_CONFIG_HOME/gfsecret/default.conf) which describes the shared +`$XDG_CONFIG_HOME/gfsecret/default.conf`) which describes the shared secret. Here is a sample configuration: - OUTFILE=/home/alice/mysecret - MINSHARES=2 - URI=file:///home/alice/.local/share/gfsecret/mysecret.024 - URI=label://MYSTICK/mysecretfile.070 - URI=mtp://RF2GB6X704P/Documents/mysecret.139 + OUTFILE=/home/alice/mysecret + MINSHARES=2 + URI=file:///home/alice/.local/share/gfsecret/mysecret.024 + URI=label://MYSTICK/mysecretfile.070 + URI=mtp://RF2GB6X704P/Documents/mysecret.139 With such a configuration, gfse-use will attempt to reconstruct the file -‘/home/alice/mysecret’, using at least two of the three available +`/home/alice/mysecret`, using at least two of the three available shares: one available on the local filesystem, one on a USB storage -device with the label ‘MYSTICK’, and one on a MTP-compliant device with -the serial number ‘RF2GB6X704P’. Gfsec-use will automatically detect +device with the label `MYSTICK`, and one on a MTP-compliant device with +the serial number `RF2GB6X704P`. Gfsec-use will automatically detect which devices are currently connected and will fetch from them the corresponding shares. @@ -41,32 +41,29 @@ Install ------- Gfsecret depends on the following libraries at compile-time: - – libgfshare , which - implements the secret sharing scheme proper (mandatory); - - – libgcrypt , for the SHA-256 implementation - (mandatory); - - – GIO , to access shares stored on - external volumes (typically USB storage) (optional); - - – libmtp , to access shares stored on - MTP-compliant devices (optional). +- [libgfshare](http://www.digital-scurf.org/software/libgfshare), which + implements the secret sharing scheme proper (mandatory); +- [libgcrypt](http://www.gnupg.org/), for the SHA-256 implementation + (mandatory); +- [GIO](http://developer.gnome.org/gio/), to access shares stored on + external volumes (typically USB storage) (optional); +- [libmtp](http://libmtp.sourceforge.net/), to access shares stored on + MTP-compliant devices (optional). Copying ------- Gfsecret is distributed under the terms of the GNU General Public License, version 3 or higher. The full license is included in the -COPYING file of the source distribution. +[COPYING file](COPYING) of the source distribution. Homepage and contact -------------------- -The project is located at . +The project is located at http://www.incenp.org/dvlpt/gfsecret.html. The latest source code is available in a Git repository at - and may also be browsed at -. +git://git.incenp.org/gfsecret.git and may also be browsed at +http://www.incenp.org/gitweb/?p=gfsecret.git;a=summary. The author may be contacted at the following address: Damien Goutte-Gattat