2ac4a8e33181ae3b467644fd41a8c7dfbd6b76eb — Drew DeVault 6 months ago 1a4debd
1 files changed, 46 insertions(+), 0 deletions(-)

A README.md => README.md +46 -0
@@ 0,0 1,46 @@
# annotatego

This program scans Go source code and emits an annotation graph for
[git.sr.ht](https://git.sr.ht)'s [code
annotations](https://man.sr.ht/git.sr.ht/annotations.md) feature.

## Usage

annotatego [-Tdv] packages... >annotations.json

The list of packages should be specified per the
[x/tools/go/packages](https://godoc.org/golang.org/x/tools/go/packages) query
format. You must run this command from the root directory of your module for it
to work correctly.

This will print annotations to stdout and progress to stderr. For information
about uploading these annotations to git.sr.ht, see the [git.sr.ht


- `-T`: scan tests in addition to normal code
- `-d`: disable linking to Godoc for external symbols (enabled by default)
- `-v`: enable linking variables to their definitions

## Example

To generate annotations for all packages in the git.sr.ht/~sircmpwn/godoc

annotatego -v git.sr.ht/~sircmpwn/godoc... > annotations.json

## Bugs, help, patches

Submit bugs to [~sircmpwn/annotate](https://todo.sr.ht/~sircmpwn/annotate).

Send support requests to

Send patches [via email](https://git-send-email.io) to
[sr.ht-dev](https://lists.sr.ht/~sircmpwn/sr.ht-dev) with `git config
format.subjectPrefix 'PATCH annotatego'`.