Skip to content

Commit

Permalink
docs: note about submodule, close antfu#61
Browse files Browse the repository at this point in the history
  • Loading branch information
antfu committed Dec 25, 2023
1 parent 8330578 commit 5225e29
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
Please refer to https://github.com/antfu/contribute

---

## Additional Notes

This repository contains a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to `vscode-textmate`. By default `git clone` does not clone submodules. To clone this repository and its submodules, use:

```bash
git clone --recursive https://github.com/antfu/shikiji
```

Or if you have already cloned it, use:

```bash
git submodule update --init --recursive
```

Learn more at this [StackOverflow thread](https://stackoverflow.com/a/4438292).

0 comments on commit 5225e29

Please sign in to comment.