Pārlūkot izejas kodu

Add README for gitstats3 project

This README provides an overview of the gitstats3 project, including features, prerequisites, installation instructions, and usage examples.
lechibang-1512 2 mēnešus atpakaļ
vecāks
revīzija
4ffb8d529c
Revīzijas autora e-pasts nav piesaistīts nevienam kontam
1 mainītis faili ar 58 papildinājumiem un 0 dzēšanām
  1. 58
    0
      README.md

+ 58
- 0
README.md Parādīt failu

@@ -0,0 +1,58 @@
1
+# gitstats3
2
+
3
+**gitstats3** is a git history statistics generator, ported from Python 2 to Python 3.
4
+
5
+This project allows you to analyze and visualize various statistics from a git repository, such as commit activity, author contributions, and more. It is a fork of the original [gitstats](https://github.com/hoxu/gitstats) project, updated to work with modern Python environments.
6
+
7
+## Features
8
+
9
+- Generates detailed statistics and graphs from git repositories
10
+- Analyzes commit history, author contribution, file changes, and more
11
+- Output is visual and easy to share
12
+
13
+## Getting Started
14
+
15
+### Prerequisites
16
+
17
+- Python 3.x
18
+- Git (installed and available in your system path)
19
+
20
+### Installation
21
+
22
+Clone the repository:
23
+
24
+```sh
25
+git clone https://github.com/lechibang-1512/gitstats3.git
26
+cd gitstats3
27
+```
28
+
29
+Install required dependencies (if any):
30
+
31
+```sh
32
+pip install -r requirements.txt
33
+```
34
+
35
+### Usage
36
+
37
+To generate statistics for a git repository:
38
+
39
+```sh
40
+python gitstats <path-to-git-repo> <output-directory>
41
+```
42
+
43
+Example:
44
+
45
+```sh
46
+python gitstats /path/to/your/repo /path/to/output
47
+```
48
+
49
+This will analyze the git repository and generate an HTML report in the output directory.
50
+
51
+## License
52
+
53
+This project is a fork of [hoxu/gitstats](https://github.com/hoxu/gitstats). Please refer to the original project for licensing details.
54
+
55
+## Acknowledgements
56
+
57
+- Original author: [hoxu/gitstats](https://github.com/hoxu/gitstats)
58
+- Ported to Python 3 by [lechibang-1512](https://github.com/lechibang-1512)