git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Rappazzo <rappazzo@gmail.com>
To: git@vger.kernel.org
Cc: j6t@kdbg.org, Michael Rappazzo <rappazzo@gmail.com>
Subject: [PATCH gitk] gitk: add README.md with contribution guidelines
Date: Wed, 20 Aug 2025 15:52:29 -0400	[thread overview]
Message-ID: <20250820195229.45943-1-rappazzo@gmail.com> (raw)

Signed-off-by: Michael Rappazzo <rappazzo@gmail.com>
---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..adf7a0ba85
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# gitk - The Git Repository Browser
+
+This is the official repository for gitk, a graphical Git repository browser.
+
+## Repository Status
+
+- **Official Repository**: https://github.com/j6t/gitk
+- **Integration**: This repository is regularly merged into the main Git repository (git.git) via subtree merges into the `gitk-git/` subdirectory
+
+## Contributing
+
+Contributions are welcome! The preferred method for submitting patches is via email to the Git mailing list, as this allows for more thorough review and broader community feedback. However, GitHub pull requests are also accepted.
+
+All commits must be signed off (use `git commit --signoff`).
+
+### Email Patches
+- Create patches from this repository (github.com/j6t/gitk), not from the `gitk-git/` subdirectory in git.git
+- Send patches to the Git mailing list: git@vger.kernel.org and CC the maintainer: j6t@kdbg.org
+- Follow the Git project's patch submission guidelines
+- Include `[PATCH gitk]` in the subject line
+
+#### Creating and Sending Patches
+After committing your changes:
+```bash
+git format-patch -1 --subject-prefix="PATCH gitk"
+git send-email --to=git@vger.kernel.org --cc=j6t@kdbg.org *.patch
+```
+
+For `git send-email` configuration, see the [documentation](https://git-scm.com/docs/git-send-email) (search for "Examples of SMTP Servers").
+
+For information about subscribing to the Git mailing list, see [subscription info](https://git.wiki.kernel.org/index.php/GitCommunity). Note that subscription is not required to participate in patch discussions.
+
+### GitHub Pull Requests
+- Fork this repository and create a feature branch
+- Submit a pull request with a clear description of your changes
+
+## Building
+
+gitk is a Tcl/Tk application. It requires Tcl/Tk to be installed on your system.
+
+### Running directly
+```bash
+./gitk
+```
+
+### Installation
+To install system-wide, you can use either `make` or `meson`:
+
+```bash
+# Using Make
+make install
+
+# Using Meson
+meson setup builddir
+meson compile -C builddir
+meson install -C builddir
+```
+
+Both build systems will handle setting the correct Tcl/Tk interpreter path and installing translation files.
+
+## License
+
+gitk is distributed under the GNU General Public License, either version 2, or (at your option) any later version.
\ No newline at end of file
-- 
2.51.0


             reply	other threads:[~2025-08-20 19:53 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-20 19:52 Michael Rappazzo [this message]
2025-08-20 20:57 ` [PATCH gitk] gitk: add README.md with contribution guidelines Junio C Hamano
2025-08-20 21:02   ` Mike Rappazzo
2025-08-20 21:12     ` Junio C Hamano
2025-08-20 21:20       ` Mike Rappazzo
2025-08-20 23:42         ` D. Ben Knoble
2025-08-20 21:03   ` Kristoffer Haugsbakk
2025-08-20 21:15     ` Junio C Hamano
2025-08-21  7:15 ` Johannes Sixt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250820195229.45943-1-rappazzo@gmail.com \
    --to=rappazzo@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=j6t@kdbg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).