From ce0f2dd8680609b194036a227aee7a35212c419d Mon Sep 17 00:00:00 2001 From: Taylor Mullen Date: Sun, 20 Apr 2025 22:19:48 -0400 Subject: Update README to reflect current state of the world. - We now have CI/CD - We have linting support (so added a section) - Fixed `npm run debug` to allow debugging again. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index b84e1ded..8ad7b555 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Gemini Code -**Disclaimer:** This README.md was created by gemini-code and this project was developed rapidly and currently lacks comprehensive testing, CI/CD pipelines, and other quality-of-life features common in mature projects. +**Disclaimer:** This README.md was created by gemini-code and this project was developed rapidly and currently lacks comprehensive testing, and other quality-of-life features common in mature projects. This repository contains the Gemini Code CLI tool. @@ -61,3 +61,13 @@ npm run format ``` This command uses Prettier to format the code according to the project's style guidelines. + +## Linting + +To lint the code in this project, run the following command fro the root directory: + +```bash +npm run lint +``` + +Chances are you will need to manually address errors output. You can also try `npm run lint -- --fix` where some errors may be resolved. -- cgit v1.2.3