diff options
| -rw-r--r-- | README.md | 80 |
1 files changed, 0 insertions, 80 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 91fafba..0000000 --- a/README.md +++ /dev/null @@ -1,80 +0,0 @@ -# gns-deb-diff - -This script is an effort to automate the documentation of the -differences between gNewSense and Debian. - -The present list of differences is documented at the -[gNewSense wiki][1]. Look at the [savannah task #12794][2] for more -info. - -See [here for notes about the script][gns-deb-diff-notes]. - -[1]: http://www.gnewsense.org/Documentation/3/DifferencesWithDebian -[2]: https://savannah.nongnu.org/task/?12794 - -## Synopsis - - $ python gns-deb-diff.py packages-list-file local-packages-directory remote-bzr-url - -**defaults** - - local-packages-directory = "~/gnewsense/packages-parkes" - remote-bzr-url = "bzr://bzr.savannah.gnu.org/gnewsense/packages-parkes" - -`packages-list-file`, is a file which contains a list of package names -that differ from Debian. Look at `packages-parkes.list` file for a -sample. - -## Configuration - -Specify the `wikiusername`, `passphrase` & the wiki's url at -`src/config/topsecret.txt`. - -The `topsecret.txt` file must follow this format: - - wikiusername - passphrase - http://wikiurl.ext - -## Description - -This is what the script does at present: - -+ **S1** The script pulls the latest version of the packages, listed - in the `packages-list-file`, from their respective bzr repos. - -+ **S2** For packages which contain the `README.gNewSense` file, a - dict of the form `{'pkg': 'package_name', 'Change-Type': - 'Added/Removed/Modified', 'Changed-From-Debian': 'one line - description'}` is generated. - - The value for keys `Change-Type` & `Changed-From-Debian` is `None`, - if they are not present in the `README.gNewSense` file. - -+ **S3** The script puts the names of packages, which doesn't contain - `README.gNewSense` file, into a separate list. - -+ **S4** The dicts produced in **S2** is used to generate - MoinMoin marked up table, like - [the one found here][gns-deb-diff-notes]. - -+ **S5** A wiki page is created using the generated table. - -+ **S6** Using XML-RPC, the wiki page is pushed to the wiki. - -+ **S7** The list of packages which doesn't contain `README.gNewSense` - is barfed out to stdout. - -[gns-deb-diff-notes]: http://www.gnewsense.org/sddhrth/gns-deb-diff-notes - -## Contact - -**rsiddharth** <rsiddharth@ninthfloor.org> or **gNewSense Hackers** <gnewsense-dev@nongnu.org> - -## License - -The script is under the [WTFPL version 2 license][3]. See COPYING for more -details. This license is [compatible with GNU GPL][4]. - -[3]: http://www.wtfpl.net/txt/copying/ -[4]: http://www.gnu.org/licenses/license-list.html#WTFPL |