From 589da2713899ee14ced13aedc1f67ac6f248de53 Mon Sep 17 00:00:00 2001 From: Adam Spiers Date: Mon, 16 Nov 2015 22:12:02 +0000 Subject: [PATCH] convert README to Markdown --- README => README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) rename README => README.md (76%) diff --git a/README b/README.md similarity index 76% rename from README rename to README.md index d8df705..9d0a5f1 100644 --- a/README +++ b/README.md @@ -4,10 +4,10 @@ README for GNU Stow This is GNU Stow, a symlink farm manager program which takes distinct packages of software and/or data located in separate directories on the filesystem, and makes them appear to be installed in the same -place. For example, /usr/local/bin could contain symlinks to files -within /usr/local/stow/emacs/bin, /usr/local/stow/perl/bin etc., and -likewise recursively for any other subdirectories such as .../share, -.../man, and so on. +place. For example, `/usr/local/bin` could contain symlinks to files +within `/usr/local/stow/emacs/bin`, `/usr/local/stow/perl/bin` etc., and +likewise recursively for any other subdirectories such as `.../share`, +`.../man`, and so on. This is particularly useful for keeping track of system-wide and per-user installations of software built from source, but can also @@ -26,12 +26,12 @@ License ------- Stow is free software, licensed under the GNU General Public License, -which can be found in the file COPYING. +which can be found in the file [`COPYING`](COPYING). Installation ------------ -See INSTALL for installation instructions. +See [`INSTALL`](INSTALL) for installation instructions. Feedback -------- @@ -49,5 +49,5 @@ things in sync, Stow stores no extra state between runs, so there's no danger (as there is in Depot) of mangling directories when file hierarchies don't match the database. Also unlike Depot, Stow will never delete any files, directories, or links that appear in a Stow -directory (e.g., /usr/local/stow/emacs), so it's always possible to -rebuild the target tree (e.g., /usr/local). +directory (e.g., `/usr/local/stow/emacs`), so it's always possible to +rebuild the target tree (e.g., `/usr/local`).