From b99e8d676ab955e973cbb03a5d0523e763690582 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Thu, 12 Dec 2013 18:45:28 +0530 Subject: update Notes section in README --- README.md | 28 ++++++++++++++++------------ 1 file 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 -- cgit v1.2.3