proj/gagit:main commit in: /

commit:     0d01789994dc059509709211407a71565c919c92
Author:     Michał Górny <mgorny <AT> gentoo <DOT> org>
AuthorDate: Mon Aug  3 19:21:04 2026 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Mon Aug  3 19:21:04 2026 +0000
URL:        https://gitweb.gentoo.org/proj/gagit.git/commit/?id=0d017899

Add a README

Signed-off-by: Michał Górny <mgorny <AT> gentoo.org>

 README.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..aac0393
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,53 @@
+=====
+GAGit
+=====
+
+GAGit is yet another AGit workflow tool, dedicated to pushing to
+the `Gentoo Codeberg mirrors`_.  The goal is to:
+
+1. Automatically figure out the correct remote and target branch,
+   accounting for different setups (such as GURU using ``dev``).
+
+2. Use the editor to provide the initial pull request description,
+   respecting the pull request template.
+
+3. Set upstream for the branch to make PR updates easy.
+
+
+Usage
+-----
+Create a new branch for your work, commit whatever you need to commit,
+then call ``gagit``::
+
+    git checkout -b my-superb-work
+    # ...
+    gagit
+
+Edit the pull request description and close the editor to push it.
+If you add further commits, you can add them to the PR via plain::
+
+    git push
+
+If you need to force push, you need to pass::
+
+    git push -o force-push=true
+
+
+Copyright
+---------
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+.. _Gentoo Codeberg mirrors: https://codeberg.org/gentoo/