Skip to content

Commit 17af0ef

Browse files
authored
Update README.md
* Clarify some points in the README.md to make a bit more sense as to why this project exists.
1 parent 311b118 commit 17af0ef

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,23 @@ reliance on Bash and external utilities:
1515

1616
- **Cross-Platform Compatibility**: `git-quick-stats` can have issues running
1717
on different platforms. For example, macOS requires GNU versions of certain
18-
utilities for proper functionality.
18+
utilities for proper functionality, and the Windows version either requires
19+
WSL or Cygwin to run.
1920
- **Dependency on External Tools**: Although it is written in Bash, it depends
20-
heavily on external tools like `awk`, `sed`, and `grep`,
21-
which may not be available or behave subtly different across systems.
21+
heavily on external tools like `tput`, `column`, and `grep`, which may not be
22+
installed depending on how the user's system is configured.
2223
- **Robust File Generation**: `git-quick-stats` has the ability to export
23-
stats in JSON and CSV format, but they are home-grown implementations.
24+
stats in JSON and CSV format, but they are home-grown implementations that
25+
are currently in experimental mode.
2426
- **Difficult to Test and Extend**: Bash scripts are inherently harder to test
25-
and extend compared to a Python-based solution.
26-
27-
Git Py Stats addresses these issues by leveraging Python's standard library,
28-
ensuring that it pulls in code tested by the Python team and works seamlessly
29-
on any platform with Python 3 installed. Its goal still maintains the spirit
30-
of `git-quick-stats` in that it will never require anything outside of
31-
Python 3 and git.
27+
and extend compared to a Python-based solution that can leverage
28+
[unittest](https://docs.python.org/3/library/unittest.html).
29+
30+
Git Py Stats tackles these challenges by leveraging Python's standard library,
31+
guaranteeing that it incorporates code vetted by the Python team and operates
32+
smoothly on any platform with Python 3 installed. It stays true to the essence
33+
of `git-quick-stats` by ensuring that no dependencies beyond Python 3 and `git`
34+
are ever required.
3235

3336
## Features
3437

0 commit comments

Comments
 (0)