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

Jump to bottom

docs: Add README #17

Merged
merged 1 commit into from
Mar 15, 2024
Merged

docs: Add README #17

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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# go-ctags: universal-ctags wrapper for easy access in Go

Note: This library is meant only for Sourcegraph use.

To improve `type:symbol` results in Sourcegraph,
for languages with high quality Tree-sitter grammars,
prefer adding support in `scip-ctags` in the Sourcegraph
monorepo over adding support in this repo.

## Adding new ctags flags

Add/modify appropriate `.ctags` files in `ctagsdotd`
and re-run `./gen.sh` at the root of the repository.

## Testing

Requires: `universal-ctags` on PATH. For exact version,
see the [CI workflow](.github/workflows/ci.yml).

Run tests: `go test ./...`

Update snapshots: `go test ./... -update`

Clean up old snapshots: `go test ./... -update -clean`
Loading