Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Revamp README.

  • Loading branch information...
commit b6f9ef2b2fb4ce11a28ec389dd620ede52ed948d 1 parent af36a44
authored March 01, 2012

Showing 1 changed file with 47 additions and 21 deletions. Show diff stats Hide diff stats

  1. 68  README
68  README
... ...
@@ -1,27 +1,53 @@
1  
-This is GNU Stow, a program for managing the installation of software
2  
-packages, keeping them separate (/usr/local/stow/emacs vs.
3  
-/usr/local/stow/perl, for example) while making them appear to be
4  
-installed in the same place (/usr/local).  Stow doesn't store an extra
5  
-state between runs, so there's no danger of mangling directories when
6  
-file hierarchies don't match the database. Also, stow will never
7  
-delete any files, directories, or links that appear in a stow
8  
-directory, so it is always possible to rebuild the target tree.
  1
+README for GNU Stow
  2
+===================
  3
+
  4
+This is GNU Stow, a symlink farm manager program which takes distinct
  5
+packages of software and/or data located in separate directories on
  6
+the filesystem, and makes them appear to be installed in the same
  7
+place.  For example, /usr/local/bin could contain symlinks to files
  8
+within /usr/local/stow/emacs/bin, /usr/local/stow/perl/bin etc., and
  9
+likewise recursively for any other subdirectories such as .../share,
  10
+.../man, and so on.
  11
+
  12
+This is particularly useful for keeping track of system-wide and
  13
+per-user installations of software built from source, but can also
  14
+facilitate a more controlled approach to management of configuration
  15
+files in the user's home directory, especially when coupled with
  16
+version control systems.
  17
+
  18
+Stow is implemented as a combination of a Perl script providing a CLI
  19
+interface, and a backend Perl module which does most of the work.
  20
+
  21
+You can get the latest information about Stow from the home page:
  22
+
  23
+    http://www.gnu.org/software/stow/
  24
+
  25
+License
  26
+-------
  27
+
  28
+Stow is free software, licensed under the GNU General Public License,
  29
+which can be found in the file COPYING.
  30
+
  31
+Installation
  32
+------------
9 33
 
10 34
 See INSTALL for installation instructions.
11 35
 
12  
-You can get the latest information about Stow from
13  
-http://www.gnu.org/software/stow/stow.html
  36
+Feedback
  37
+--------
14 38
 
15  
-Stow was inspired by Carnegie Mellon's "Depot" program, but is substantially
16  
-simpler.  Whereas Depot requires database files to keep things in sync, Stow
17  
-stores no extra state between runs, so there's no danger (as there is in
18  
-Depot) of mangling directories when file hierarchies don't match the database.
19  
-Also unlike Depot, Stow will never delete any files, directories, or links
20  
-that appear in a Stow directory (e.g., /usr/local/stow/emacs), so it's always
21  
-possible to rebuild the target tree (e.g., /usr/local).
  39
+Please do send comments, questions, and constructive criticism.  The
  40
+mailing lists and any other communication channels are detailed on the
  41
+above home page.
22 42
 
23  
-Stow is free software, licensed under the GNU General Public License, which
24  
-can be found in the file COPYING.
  43
+Brief history
  44
+-------------
25 45
 
26  
-Please mail comments, questions, and criticisms to the current maintainers
27  
-via help-stow@gnu.org or bug-stow@gnu.org.
  46
+Stow was inspired by Carnegie Mellon's "Depot" program, but is
  47
+substantially simpler.  Whereas Depot requires database files to keep
  48
+things in sync, Stow stores no extra state between runs, so there's no
  49
+danger (as there is in Depot) of mangling directories when file
  50
+hierarchies don't match the database.  Also unlike Depot, Stow will
  51
+never delete any files, directories, or links that appear in a Stow
  52
+directory (e.g., /usr/local/stow/emacs), so it's always possible to
  53
+rebuild the target tree (e.g., /usr/local).

0 notes on commit b6f9ef2

Please sign in to comment.
Something went wrong with that request. Please try again.