Changeset 525 for trunk/doc

Timestamp:

Dec 25, 2007, 4:06:14 AM (15 years ago)

Author:

Peter Johansson

Message:

improved text a bit

File:

• trunk/doc/readme.txt (modified) (1 diff)

trunk/doc/readme.txt

@@ -39 +39 @@
 ''other''. 
 
-From svndigest 0.7 which rules to be used for different files can be
-set in the configuration file. For more on configuration file see
-below. If no configuration file is given or no rules are given, a set
-of default rules are used. For files named `*.h`, for example, use
-rules allowing to detect comments as either `// ... \n` or `/*
-... */`. This rule can be set in the configuration file using a
-one-liner like: 
+From svndigest 0.7, it is possible to set the configuration file which
+rules are used for different files. For more on how to configure
+svndigest see below. If no configuration file is given or no rules are
+given, a set of default rules are used. For files named `*.h`, for
+example, rules allowing to detect comments as either `// ... \n` or
+`/* ... */`. These rules can be set in the configuration file using a
+one-liner like:
 
 `*.h = "//":"\n"  ;  "/*":"*/"`
 
-The first string (`*h`) is a file-name-pattern describing which files
+The first string (`*.h`) is a file-name-pattern describing which files
 this rule will be used on. The second block, `"//":"\n"`, is the first
 rule saying one way to mark comments is to start with a ''start
 code'', `//`, and end with an ''end code'', `\n`. The start and end
 codes are surrounded by `""` and separated by `:`. Similarily, the
-second block describes comments also could come as `/* ... */`. 
+second block describes that comments also could come as `/* ... */`.
+
+For a more detailed illustration, please have a look at `config` that
+can be found in directory `.svndigest`, and the svndigest screenshots
+that can be reached through http://trac.thep.lu.se/svndigest/.
 
 == Different file types ==