Skip to content

Commit 045ab35

Browse files
authored
Refine README formatting and content
Updated README to improve formatting and clarify command-line arguments and custom metrics section.
1 parent cd9c679 commit 045ab35

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
Code evolution analysis for Git repositories.
66
It currently supports Python, JavaScript, TypeScript, and Java.
7+
GitEvo can also be used to define custom code evolution metrics at the level of the concrete syntax tree (CST), thanks to [Tree-sitter](https://tree-sitter.github.io/tree-sitter).
78

89
Examples of reports:
910
[Flask](https://andrehora.github.io/gitevo-examples/python/flask.html),
@@ -57,7 +58,7 @@ $ git clone https://github.com/pallets/click
5758
$ gitevo -r python .
5859
```
5960

60-
## Command line arguments
61+
### Command-line arguments
6162

6263
```
6364
$ gitevo --help
@@ -81,7 +82,7 @@ options:
8182
-v, --version Show the GitEvo version.
8283
```
8384

84-
## Defining Custom Metrics
85+
## Defining custom metrics
8586

8687
GitEvo can be used to define custom code evolution metrics at the level of the concrete syntax tree (CST), thanks to [Tree-sitter](https://tree-sitter.github.io/tree-sitter).
8788
GitEvo provides three key classes that can be used in the scripts: `GitEvo`, `ParsedCommit`, and `ParsedFile`.

0 commit comments

Comments
 (0)