Initial, works-for-me script to import Gitlab issues to Sourcehut.

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3546eba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# lazygl2srht - Gitlab to Sourcehut issue migration tool
+
+This is a program for importing issues from an exported Gitlab project into a
+fresh Sourcehut tracker, via SMTP.  I am lazy, so this works well enough for my
+simple projects, but certainly doesn't include all data that could be included,
+and also requires some manual work on your part for best results.
+
+Documentation is included at the top of `import_issues.py`.  Please read that
+before running an import.
+
+## License
+
+Copyright 2024 Bryan Gardiner <bog@khumba.net>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.