{"thread":{"id":"64049","subject":"[PATCH v3] gitk: add README with usage, build, and contribution details","startedAt":"2025-08-27T23:14:41Z","lastAt":"2025-08-28T17:54:10Z","messageCount":2,"participants":["Michael Rappazzo","Johannes Sixt"],"isPatch":true,"patchVersion":3,"patchTotal":null},"messages":[{"id":"525083","messageId":"20250827231417.12449-1-rappazzo@gmail.com","threadId":"64049","inReplyTo":null,"subject":"[PATCH v3] gitk: add README with usage, build, and contribution details","fromName":"Michael Rappazzo","fromEmail":"rappazzo@gmail.com","sentAt":"2025-08-27T22:59:56Z","receivedAt":"2025-08-27T23:14:41Z","isPatch":true,"sender":{"key":"rappazzo@gmail.com","avatar":"https://avatars.githubusercontent.com/u/525287?v=4"},"body":"Signed-off-by: Michael Rappazzo <rappazzo@gmail.com>\n---\nChanges from v2:\n - use 'Gitk' to refer to the software, and 'gitk' to refer to the\n   command\n - change the markdown section format to use underlines\n - wrap lines at 70-ish characters\n - add more details and examples in the `make` details\n\n README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 93 insertions(+)\n create mode 100644 README.md\n\ndiff --git a/README.md b/README.md\nnew file mode 100644\nindex 0000000000..bd3e9a6481\n--- /dev/null\n+++ b/README.md\n@@ -0,0 +1,93 @@\n+Gitk - The Git Repository Browser\n+=================================\n+\n+Gitk is a graphical Git repository browser. It displays the commit\n+history of a Git repository as a graph, showing the relationships\n+between commits, branches, and tags.\n+\n+Usage\n+=====\n+\n+To view the history of the current repository:\n+```bash\n+gitk\n+```\n+\n+To view the history of specific files or directories:\n+```bash\n+gitk path/to/file\n+gitk path/to/directory\n+```\n+\n+To view a specific branch or range of commits:\n+```bash\n+gitk branch-name\n+gitk v1.0..v2.0\n+```\n+\n+For more usage examples and options, see the [gitk manual](https://git-scm.com/docs/gitk).\n+\n+Building\n+========\n+\n+Gitk is a Tcl/Tk application. It requires Tcl/Tk to be installed on\n+your system.\n+\n+Running directly\n+----------------\n+\n+Gitk can be run from the source directory without installation:\n+\n+```bash\n+./gitk\n+```\n+\n+This allows for quick testing of changes.\n+\n+Installation\n+------------\n+\n+To install system-wide, you can use either `make` or `meson`:\n+\n+```bash\n+# Install to default location ($HOME/bin)\n+make install\n+\n+# Install to system-wide location\n+sudo make install prefix=/usr/local\n+\n+# Install to custom location\n+make install prefix=/opt/gitk\n+\n+# Using Meson\n+meson setup builddir\n+meson compile -C builddir\n+meson install -C builddir\n+```\n+\n+Both build systems will handle setting the correct Tcl/Tk interpreter\n+path and installing translation files.\n+\n+Contributing\n+============\n+\n+Contributions are welcome! The preferred method for submitting patches\n+is via email to the Git mailing list, as this allows for more thorough\n+review and broader community feedback. However, GitHub pull requests\n+are also accepted.\n+\n+All commits must be signed off (use `git commit --signoff`) and should\n+have commit messages prefixed with `gitk:`.\n+\n+Email Patches\n+-------------\n+\n+Send patches to git@vger.kernel.org and CC j6t@kdbg.org. See the Git\n+project's [patch submission guidelines](https://git-scm.com/docs/SubmittingPatches)\n+for detailed instructions on creating and sending patches.\n+\n+License\n+=======\n+\n+Gitk is distributed under the GNU General Public License, either\n+version 2, or (at your option) any later version.\n\\ No newline at end of file\n-- \n2.51.0\n\n"},{"id":"525135","messageId":"86240b73-c775-4d4d-8904-30e8b536e5be@kdbg.org","threadId":"64049","inReplyTo":"20250827231417.12449-1-rappazzo@gmail.com","subject":"Re: [PATCH v3] gitk: add README with usage, build, and contribution details","fromName":"Johannes Sixt","fromEmail":"j6t@kdbg.org","sentAt":"2025-08-28T17:54:01Z","receivedAt":"2025-08-28T17:54:10Z","isPatch":true,"sender":{"key":"j6t@kdbg.org","avatar":"https://avatars.githubusercontent.com/u/14810926?v=4"},"body":"Thanks, queued after fixing up this glitch:\n\n> \\ No newline at end of file\n\n"}]}