Skip to content
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

Update README.md #98

Merged
merged 2 commits into from
Jun 17, 2024
Merged

Update README.md #98

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8850359
Update README.md
laniakea64 Jun 17, 2024
5ad2c6b
Document that `nvim-treesitter` takes precedence
laniakea64 Jun 17, 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
31 changes: 21 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,35 @@ For questions or issues when using these packages, contact the package's maintai

[![Packaging status](https://repology.org/badge/vertical-allrepos/vim:vim-just.svg)](https://repology.org/project/vim:vim-just/versions)

----------
## Using alongside `nvim-treesitter`

### Updating `git clone` based installations
If `nvim-treesitter` is installed and has a justfile language parser available,
`nvim-treesitter` will overrule `vim-just` by default.

Run the same `cd` command as in the relevant installation instructions, then:
To use `vim-just` syntax highlighting with other `nvim-treesitter` features,
configure `nvim-treesitter` not to use its justfile language parser for syntax highlighting:

```bash
cd vim-just
git pull --tags --verbose
```lua
require("nvim-treesitter.configs").setup({
highlight = {
enable = true,
disable = { "just" },
},
})
```

#### Old `git clone` based installations
For more details or more complex configurations, see
[nvim-treesitter documentation](https://github.com/nvim-treesitter/nvim-treesitter#modules).

In late March 2023, development was moved from `master` branch to `main` branch, and `master` is no longer maintained. Updating installations that used a `git clone` prior to these changes requires some additional one-time steps, run **after** the normal update procedure:
## Migrating old `git clone` based installations to `main`

In late March 2023, development was moved from `master` branch to `main` branch,
and `master` is no longer maintained.
Updating installations that used a `git clone` prior to these changes requires some
additional one-time steps:

```bash
git fetch
git checkout main
git branch -d master || git branch --unset-upstream master
git remote set-head origin -a
Expand All @@ -60,8 +73,6 @@ git remote prune origin

Now future updates can again be obtained normally.

----------

## Contributing & Development

See [CONTRIBUTING.md](CONTRIBUTING.md).