summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
-rw-r--r--package.json2
2 files changed, 12 insertions, 2 deletions
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.
diff --git a/package.json b/package.json
index b0d56370..b55822ae 100644
--- a/package.json
+++ b/package.json
@@ -11,7 +11,7 @@
"clean": "rm -rf node_modules && npm run clean --workspaces",
"test": "npm run test --workspaces",
"start": "scripts/start.sh",
- "debug": "scripts/debug.sh",
+ "debug": "node ./scripts/check-build-status.js && node --inspect-brk node_modules/@gemini-code/cli",
"fix": "eslint . --fix",
"lint": "eslint . --ext .ts,.tsx",
"typecheck": "tsc --noEmit --jsx react",