Skip to content

Update README #5

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

Merged
simondeeley merged 1 commit into from
Apr 5, 2025
Merged

Update README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,18 @@ nix flake new --template "https://flakehub.com/f/simondeeley/tree-sitter-dev/0.1

## How to use the template

Once your preferred template has been initialized, you can use the provided shell in two ways:
Once the template has been initialized, you can use the provided shell in two ways:

1. If you have [`nix-direnv`][nix-direnv] installed, you can initialize the environment by running `direnv allow`.
2. If you don't have `nix-direnv` installed, you can run `nix develop` to open up the Nix-defined shell.

## Included Packages

- [Node.js][node] 18.16.1
- [Node.js][node-gyp] 10.2.0
- [npm] 9.5.1
- [tree-sitter] 0.24.6

## tree-sitter
`tree-sitter` is a parser generator for programming languages. It is designed to be fast, small, and embeddable. It is used by many popular editors and IDEs to provide syntax highlighting and code completion. To read more about `tree-sitter`, visit the [official website](https://tree-sitter.github.io/tree-sitter/).

Expand Down
Loading