Skip to content

Commit b7569ce

Browse files
Document recommended git version
Fixes tosdr/edit.tosdr.org#1162
1 parent 5a99b97 commit b7569ce

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

content/_index.en.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ A [Node.js](https://nodejs.org/en/download/) runtime is required to execute this
109109
110110
![Supported Node.js version can be found in the package.json file](https://img.shields.io/node/v/@opentermsarchive/engine?color=informational&label=Supported%20Node.js%20version)
111111
112+
Note that older versions of `git` will work but can slow the engine down. It's recommended to use git version 2.29 or higher, and to run:
113+
```
114+
git commit-graph write --reachable --changed-paths
115+
```
116+
in the snapshot and version repositories.
117+
112118
### Getting started
113119
114120
This engine is published as a [module on NPM](https://npmjs.com/package/@opentermsarchive/engine). The recommended install is as a dependency in a `package.json` file, next to a folder containing [declaration files](#declarations).

0 commit comments

Comments
 (0)