From 52567d3d5c844ab0c82e0362bc92c326ec669400 Mon Sep 17 00:00:00 2001 From: Thomas ten Cate Date: Sun, 13 Mar 2011 17:44:31 +0100 Subject: Rename README to make GitHub use Markdown. --- README | 37 ------------------------------------- README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 37 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 28998a6..0000000 --- a/README +++ /dev/null @@ -1,37 +0,0 @@ -sf2github README -================ - -`sf2github` is a Python program that reads an XML export from a SourceForge project and pushes this data to GitHub via its REST API. - -The script is currently very incomplete and barely tested. If it works for you, great; if not, fix it up and send me a pull request! Currently, only migration of tracker issues is partly implemented, and there's no error handling. - -Also note that the GitHub API is quite slow, taking about 5 seconds per request on my machine and internet connection. Migration of a large project will take a while. - -Issue migration ---------------- - -What works (for me): - -* SF tracker issues become GitHub tracker issues. -* Comments on SF become comments in GitHub. -* Groups and categories on SF both become labels on GitHub. -* Issues with a status that is exactly the text "Closed" or "Deleted" will be closed on GitHub. - -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. - -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`: - - ./issues.py foo.xml john/bar - -License -------- - -This software is in the public domain. I accept no responsibility for any damage resulting from it. Use at your own risk. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..28998a6 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +sf2github README +================ + +`sf2github` is a Python program that reads an XML export from a SourceForge project and pushes this data to GitHub via its REST API. + +The script is currently very incomplete and barely tested. If it works for you, great; if not, fix it up and send me a pull request! Currently, only migration of tracker issues is partly implemented, and there's no error handling. + +Also note that the GitHub API is quite slow, taking about 5 seconds per request on my machine and internet connection. Migration of a large project will take a while. + +Issue migration +--------------- + +What works (for me): + +* SF tracker issues become GitHub tracker issues. +* Comments on SF become comments in GitHub. +* Groups and categories on SF both become labels on GitHub. +* Issues with a status that is exactly the text "Closed" or "Deleted" will be closed on GitHub. + +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. + +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`: + + ./issues.py foo.xml john/bar + +License +------- + +This software is in the public domain. I accept no responsibility for any damage resulting from it. Use at your own risk. + -- cgit v1.2.1