Skip to content

Commit

Permalink
doc: Recommend built-in integration on Emacs 29+
Browse files Browse the repository at this point in the history
  • Loading branch information
ubolonton committed Dec 31, 2022
1 parent c3fe96a commit d3eab87
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![Azure Pipelines](https://dev.azure.com/emacs-tree-sitter/elisp-tree-sitter/_apis/build/status/ci?branchName=master&label=build&api-version=6.0-preview.1)](https://dev.azure.com/emacs-tree-sitter/elisp-tree-sitter/_build/latest?definitionId=1&branchName=master)
[![GitHub Actions](https://github.com/emacs-tree-sitter/elisp-tree-sitter/actions/workflows/main.yml/badge.svg)](https://github.com/emacs-tree-sitter/elisp-tree-sitter/actions/workflows/main.yml)

For Emacs 29+, please use [the built-in integration](https://lists.gnu.org/archive/html/emacs-devel/2022-11/msg01443.html) instead of this package.

This is an Emacs Lisp binding for [tree-sitter](https://tree-sitter.github.io/tree-sitter/), an incremental parsing library. It requires Emacs 25.1 or above, built with dynamic module support.

It aims to be the foundation for a new breed of Emacs packages that understand code structurally. For example:
Expand Down Expand Up @@ -71,7 +73,7 @@ To test against a different version of Emacs, set the environment variable `EMAC

## Alternatives

- Tree-sitter in Emacs's core: https://github.com/casouri/emacs (the future)
- [Tree-sitter in Emacs's core](https://lists.gnu.org/archive/html/emacs-devel/2022-11/msg01443.html) (the future)
- Binding through C instead of Rust: https://github.com/karlotness/tree-sitter.el (dormant)
## Contribution
Expand Down
2 changes: 2 additions & 0 deletions doc/emacs-tree-sitter.org
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
:EXPORT_HUGO_TYPE: homepage
:END:

For Emacs 29+, please use [[https://lists.gnu.org/archive/html/emacs-devel/2022-11/msg01443.html][the built-in integration]] instead.

~tree-sitter~ is an Emacs binding for [[https://tree-sitter.github.io/][Tree-sitter]], an incremental parsing system.

It aims to be the foundation for a new breed of Emacs packages that understand code structurally. For example:
Expand Down

0 comments on commit d3eab87

Please sign in to comment.