Permalink
Browse files

Tidy up readme.

  • Loading branch information...
1 parent 9291ca8 commit e2717c7e3805d5862f9b6d08660259988605b19d @joelpt joelpt committed Oct 14, 2012
Showing with 8 additions and 17 deletions.
  1. +8 −17 README.md
View
@@ -1,7 +1,7 @@
This is a simple script to migrate issues from Google Code to Github.
-For a full history of changes, including the many additions found in this fork, please
-consult the [change log](https://github.com/dnschnur/google-code-issues-migrator/blob/master/CHANGES.md).
+For a full history of changes, please
+consult the [change log](https://github.com/arthur-debert/google-code-issues-migrator/blob/master/CHANGES.md).
### How it works ###
@@ -23,16 +23,7 @@ what's already on Github.
### Required Python libraries ###
* [gdata](http://code.google.com/p/gdata-python-client/) -- `pip install gdata`
-* [PyGithub](https://github.com/jacquev6/PyGithub/) -- `pip install PyGithub`
-
-Note that you must use version 1.8.0 or greater of PyGithub. This is due to a limitation
-in Github's API that results in a 500 error if clients try to submit a string containing a
-percent-sign. Earlier versions of this script worked around the problem by escaping the
-symbol, but this caused further problems by making it more difficult to correlate original
-Google Code issues with their migrated copies.
-
-We removed the script's escaping once PyGithub introduced a work-around for the problem,
-which was first included in their 1.8.0 release.
+* [PyGithub](https://github.com/jacquev6/PyGithub/) -- `pip install PyGithub` -- v1.8.0+ required
### Usage ###
@@ -51,18 +42,18 @@ which was first included in their 1.8.0 release.
You will be prompted for your github password.
---assign-owner automatically assigns any issues that currently have an owner to your
-Github user (the one running the script), even if you weren't the origina lowner. This
+`--assign-owner` automatically assigns any issues that currently have an owner to your
+Github user (the one running the script), even if you weren't the original owner. This
is used to save a little time in cases where you do in fact own most issues.
---dry-run does as much as possible without actually adding anything to Github. It's
+`--dry-run` does as much as possible without actually adding anything to Github. It's
useful as a test, to turn up any errors or unexpected behaviors before you run the script,
irreversibly, on your real repository.
---omit-priorities skips migration of Google Code Priority labels, since many projects
+`--omit-priorities` skips migration of Google Code Priority labels, since many projects
don't actually use them, and would just remove them from Github anyway.
---synchronize-ids attempts to ensure that every Github issue gets the same ID as its
+`--synchronize-ids` attempts to ensure that every Github issue gets the same ID as its
original Google Code issue. Normally this happens anyway, but in some cases Google Code
skips issue numbers; this option fills the gaps with dummy issues to ensure that the next
real issue keeps the same numbering. This only works, of course, if the migration starts

0 comments on commit e2717c7

Please sign in to comment.