Skip to content

Commit ac8fec7

Browse files
rappazzoj6t
authored andcommitted
gitk: add README with usage, build, and contribution details
Signed-off-by: Michael Rappazzo <[email protected]> Signed-off-by: Johannes Sixt <[email protected]>
1 parent 3fbbbe2 commit ac8fec7

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

README.md

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

0 commit comments

Comments
 (0)