Git fork
at reftables-rust 93 lines 2.1 kB view raw view rendered
1Gitk - The Git Repository Browser 2================================= 3 4Gitk is a graphical Git repository browser. It displays the commit 5history of a Git repository as a graph, showing the relationships 6between commits, branches, and tags. 7 8Usage 9===== 10 11To view the history of the current repository: 12```bash 13gitk 14``` 15 16To view the history of specific files or directories: 17```bash 18gitk path/to/file 19gitk path/to/directory 20``` 21 22To view a specific branch or range of commits: 23```bash 24gitk branch-name 25gitk v1.0..v2.0 26``` 27 28For more usage examples and options, see the [gitk manual](https://git-scm.com/docs/gitk). 29 30Building 31======== 32 33Gitk is a Tcl/Tk application. It requires Tcl/Tk to be installed on 34your system. 35 36Running directly 37---------------- 38 39Gitk can be run from the source directory without installation: 40 41```bash 42./gitk 43``` 44 45This allows for quick testing of changes. 46 47Installation 48------------ 49 50To install system-wide, you can use either `make` or `meson`: 51 52```bash 53# Install to default location ($HOME/bin) 54make install 55 56# Install to system-wide location 57sudo make install prefix=/usr/local 58 59# Install to custom location 60make install prefix=/opt/gitk 61 62# Using Meson 63meson setup builddir 64meson compile -C builddir 65meson install -C builddir 66``` 67 68Both build systems will handle setting the correct Tcl/Tk interpreter 69path and installing translation files. 70 71Contributing 72============ 73 74Contributions are welcome! The preferred method for submitting patches 75is via email to the Git mailing list, as this allows for more thorough 76review and broader community feedback. However, GitHub pull requests 77are also accepted. 78 79All commits must be signed off (use `git commit --signoff`) and should 80have commit messages prefixed with `gitk:`. 81 82Email Patches 83------------- 84 85Send patches to git@vger.kernel.org and CC j6t@kdbg.org. See the Git 86project's [patch submission guidelines](https://git-scm.com/docs/SubmittingPatches) 87for detailed instructions on creating and sending patches. 88 89License 90======= 91 92Gitk is distributed under the GNU General Public License, either 93version 2, or (at your option) any later version.