Merge pull request #1 from albertz/master

multiple trackers. more safety. more output

1 files changed, 9 insertions, 1 deletions

diff --git a/README.md b/README.md
index 28998a6..ec1173e 100644
--- a/README.md
+++ b/README.md
@@ -22,11 +22,19 @@ Limitations:
 * Only a single tracker is supported, though this could be easily fixed.
 * All issues and comments will be owned by the project's owner on GitHub, but mention the SF username of the original submitter.
 * There's some rubbish in the comment text sometimes (Logged In, user_id, Originator) but this is in the SF XML export.
+* There are encoding errors in the SF export of (at least) comments. Non-ASCII characters are encoded with UTF-8, then decoded (interpreted) as CP1252, and those code points gets encoded as XML entities. The script does not work around this. See also http://stackoverflow.com/questions/5291081/how-did-sourceforge-maim-this-unicode-character
+
+Code migration
+--------------
+
+This script doesn't help you to migrate code from SF's Subversion to GitHub. However, I found the following page helpful in doing that: http://help.github.com/svn-importing/
 
 Usage
 -----
 
-Run the `issues.py` script and it will print instructions. Basically, if your SF XML export is in `foo.xml`, your GitHub username is `john` and your repository is `bar`:
+From SourceForge, you need to export the tracker data in XML. Read [here](https://sourceforge.net/apps/trac/sourceforge/wiki/XML%20export) for instructions.
+
+Run the `issues.py` script and it will print further instructions. Basically, if your SF XML export is in `foo.xml`, your GitHub username is `john` and your repository is `bar`:
 
     ./issues.py foo.xml john/bar