summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <rsiddharth@ninthfloor.org>2013-12-12 18:45:28 +0530
committerrsiddharth <rsiddharth@ninthfloor.org>2013-12-12 18:45:28 +0530
commitb99e8d676ab955e973cbb03a5d0523e763690582 (patch)
tree8c875a2596988195d9d482e62e82f0fb2815d6d0
parent0259d6db2c6c8390e1f81340f9acc84d38816385 (diff)
update Notes section in README
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index 017161f..a480669 100644
--- a/README.md
+++ b/README.md
@@ -49,18 +49,22 @@ is barfed out to stdout.
## Notes
-1. At present the script reads the whole `README.gNewSense` file and
-puts it in the second column of the table. The file typically about 10
-lines big & contains newlines.
-
-Unforunately, the MoinMoin markup for the table doesn't allow the
-columns to have new lines. So, the table generated by the script, at
-present, must be manually edited to remove newlines.
-
-A possible solution would be to have a one line description, of how
-the respective package differs from Debian, at the beginning of the
-`README.gNewSense`. This line can then be used by the script to
-generate the table.
+1. At present the script reads the whole `README.gNewSense` file and
+ puts it in the second column of the table. The file typically about 10
+ lines big & contains newlines.
+
+ Unforunately, the MoinMoin markup for the table doesn't allow the
+ columns to have new lines. So, the table generated by the script, at
+ present, must be manually edited to remove newlines.
+
+ A possible solution would be to have a one line description, of
+ how the respective package differs from Debian, at the beginning of
+ the `README.gNewSense`. This line can then be used by the script to
+ generate the table.
+
+2. At present, not all packages contain a `README.gNewSense`
+ file. It'd nice, if all packages that were modified/removed/added
+ in gNewSense have this file.
## License