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.
This commit is contained in:
parent
d668600672
commit
ce0f2dd868
12
README.md
12
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Gemini Code
|
# 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.
|
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.
|
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.
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
"clean": "rm -rf node_modules && npm run clean --workspaces",
|
"clean": "rm -rf node_modules && npm run clean --workspaces",
|
||||||
"test": "npm run test --workspaces",
|
"test": "npm run test --workspaces",
|
||||||
"start": "scripts/start.sh",
|
"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",
|
"fix": "eslint . --fix",
|
||||||
"lint": "eslint . --ext .ts,.tsx",
|
"lint": "eslint . --ext .ts,.tsx",
|
||||||
"typecheck": "tsc --noEmit --jsx react",
|
"typecheck": "tsc --noEmit --jsx react",
|
||||||
|
|
Loading…
Reference in New Issue