Skip to content

Document recommended git version #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Document recommended git version #142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7569ce
Document recommended git version
michielbdejong Sep 10, 2024
8f7d4b4
mention reliance on skip options from https://github.com/OpenTermsArc…
michielbdejong Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ A [Node.js](https://nodejs.org/en/download/) runtime is required to execute this

![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)

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:
```
git commit-graph write --reachable --changed-paths
```
in the snapshot and version repositories. This will significantly increase performance, especially if combined with the `--skipPreRun` and `--skipSnapshots` or `--skipReadBack` options.

### Getting started

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).
Expand Down