Skip to content

Commit

Permalink
Update the main README to point to the lexers/README (#777)
Browse files Browse the repository at this point in the history
This will make it clearer where the tests are.
When I first contributed I didn't see past the "try it with chromad" instructions.
  • Loading branch information
dneto0 committed Mar 26, 2023
1 parent 0eecb2a commit 7c08f45
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -281,7 +281,7 @@ for that setup the `chroma` executable can be just symlinked to `~/.lessfilter`.

<a id="markdown-testing-lexers" name="testing-lexers"></a>
## Testing lexers
If you edit some lexers and want to test it, open a shell in `cmd/chromad` and run:
If you edit some lexers and want to try it, open a shell in `cmd/chromad` and run:
```shell
go run .
```
Expand All @@ -291,6 +291,7 @@ If you want to run the tests and the lexers, open a shell in the root directory
```shell
go test ./lexers
```
When updating or adding a lexer, please add tests. See [lexers/README.md](lexers/README.md) for more.

## What's missing compared to Pygments?

Expand Down

0 comments on commit 7c08f45

Please sign in to comment.