From: W. Trevor King <wking@tremily.us>
Date: Sat, 28 Mar 2015 20:07:00 +0000 (-0700)
Subject: README: Switch from {section}/{option} to {section}.{option}
X-Git-Tag: v0.6.2~3
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=4f9c4b2986a437c68ba99dc820ec583231cd4e48;p=update-copyright.git

README: Switch from {section}/{option} to {section}.{option}

To match the usual syntax used by Git [1] (which I expect will be more
familiar to most users).

[1]: http://git-scm.com/docs/git-config#_variables
---

diff --git a/README b/README
index a91e6bb..b90e8e2 100644
--- a/README
+++ b/README
@@ -75,33 +75,33 @@ like::
 Options
 -------
 
-project/name
+project.name
   A string naming your project.  Replaces ``{project}`` in your
   copyright blurbs.  If this isn't set, ``update-copyright`` will fall
   back to using the name of the repository directory.
-project/vcs
+project.vcs
   The name of your version control system.
-files/authors
+files.authors
   Should ``update-copyright.py`` generate an ``AUTHORS`` file?
   ``yes`` or ``no``.
-files/files
+files.files
   Should ``update-copyright.py`` update copyright blurbs in versioned
   files?  ``yes`` or ``no``.
-files/ignored
+files.ignored
   A pipe-separated list of globs matching files that should not have
   copyright blurbs updated.  This protects files that may accidentally
   caught by the blurb update algorithm.
-files/pyfile
+files.pyfile
   The path of an autogenerated license module, in case your program
   wants to print out its copyright/licensing information.  If you
   don't set this option, no license module will be generated.
-copyright/short
+copyright.short
   A list of paragraphs (separated by blank lines) containing your
   short copyright/license blurb.  This blurb is used in the pyfile's
-  ``short_license`` function (see `files/pyfile`).  This exists
+  ``short_license`` function (see `files.pyfile`).  This exists
   because some programs print a short license blurb on startup, where
   the full file-topping blurb may be overkill.
-copyright/long
+copyright.long
   A list of paragraphs (separated by blank lines) containing your long
   copyright/license blurb.  This blurb is used to replace copyright
   blurbs in your source files.