Skip to content

Commit 811eb30

Browse files
authored
Update README.md
Updating README.md with new screenshot and some additional minor tweaks.
1 parent 2994b2a commit 811eb30

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It offers a similar set of git statistics and reports, but it's built entirely
1919
using Python 3, providing improved cross-platform compatibility
2020
and ease of maintenance.
2121

22-
![mainMenuScreenshot](https://github.com/user-attachments/assets/4c3f49d8-62a9-4208-a968-5270e36aa3b8)
22+
![mainMenuScreenshot](https://github.com/user-attachments/assets/fc9ff78c-134c-4cb5-a910-10c005e98aff)
2323

2424
## Table of Contents
2525

@@ -58,7 +58,9 @@ reliance on Bash and external utilities:
5858
WSL or Cygwin to run.
5959
- **Dependency on External Tools**: Although it is written in Bash, it depends
6060
heavily on external tools like `tput`, `column`, and `grep`, which may not be
61-
installed depending on how the user's system is configured.
61+
installed depending on how the user's system is configured, especially if you
62+
happen to be running this on a minimal Linux distro targeted for embedded
63+
devices with a sparse dev environment.
6264
- **Robust File Generation**: `git-quick-stats` has the ability to export
6365
stats in JSON and CSV format, but they are home-grown implementations that
6466
are currently in experimental mode.
@@ -119,6 +121,8 @@ to the parent project:
119121

120122
If your `python` is symlinked to Python 2, you can use
121123
[`pyenv`](https://github.com/pyenv/pyenv) to switch between Python versions.
124+
Alternatively, as long as Python 3 is installed, you should be able to replace
125+
any of the `python` commands with `python3`.
122126

123127
- **Git**:
124128
Git should be installed and available in your system's `PATH`.
@@ -309,8 +313,9 @@ export _GIT_BRANCH="master"
309313
310314
### Color Themes
311315
312-
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
313-
You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
316+
You can change to the legacy color scheme by toggling the variable `_MENU_THEME`
317+
between `default` and `legacy`. You can completely disable the color theme by
318+
setting the `_MENU_THEME` variable to `none`.
314319
315320
```bash
316321
export _MENU_THEME="legacy"
@@ -322,7 +327,18 @@ export _MENU_THEME="none"
322327
323328
We welcome contributions of all kinds! Please read our
324329
[CONTRIBUTING.md](https://github.com/tomice/git-py-stats/blob/main/CONTRIBUTING.md)
325-
guide to learn how to get involved.
330+
guide to learn how to get involved. It contains more detailed information to
331+
help walk you through how to contribute. If there are any questions, feel free
332+
to ask when submitting your issue or PR, and one of the maintainers will help!
333+
334+
To sum it up, please do the following:
335+
336+
1. Create an [issue](https://github.com/git-quick-stats/git-py-stats/issues/new) on GitHub.
337+
2. Clone the [repo](https://github.com/git-quick-stats/git-py-stats) and make your changes.
338+
3. Write the accompanying [tests](https://docs.python.org/3/library/unittest.html).
339+
4. Auto lint with [`ruff`](https://github.com/astral-sh/ruff).
340+
5. Auto format with [`black`](https://github.com/psf/black).
341+
6. Submit the [PR](https://github.com/git-quick-stats/git-py-stats/compare).
326342
327343
## Code of Conduct
328344

0 commit comments

Comments
 (0)