From 7c08f459bd8b1b9b21437faf27082cd9246c7e15 Mon Sep 17 00:00:00 2001 From: David Neto Date: Sun, 26 Mar 2023 18:02:17 -0400 Subject: [PATCH] Update the main README to point to the lexers/README (#777) This will make it clearer where the tests are. When I first contributed I didn't see past the "try it with chromad" instructions. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39c98e875..124ff9f5a 100644 --- a/README.md +++ b/README.md @@ -281,7 +281,7 @@ for that setup the `chroma` executable can be just symlinked to `~/.lessfilter`. ## 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 . ``` @@ -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?