update readme

This commit is contained in:
Egor 2025-09-05 12:21:08 -07:00
parent f094904172
commit 17e4f53c60
3 changed files with 24 additions and 19 deletions

View file

@ -116,7 +116,7 @@ CLI mode will only work correctly on Windows if you install Gerbil using the Set
You can use the CLI mode on Windows in exactly the same way as in the Linux/macOS examples above, except you'll be calling the "Gerbil.exe". Note that it will not be on your system PATH by default, so you'll need to manually specify the full path to it when callig it from the Windows terminal.
## For Local Dev
## Local Dev
### Prerequisites
@ -150,6 +150,11 @@ You can use the CLI mode on Windows in exactly the same way as in the Linux/macO
yarn dev
```
## Known Issues
- automatic GPU layer detection does not currently work consistently accross all backends and platforms. It's advised to set this configuration manually if you are told in the launch terminal that your VRAM could not be detected. It should work correctly on all platforms after 1.99.0 of KoboldCpp gets released except for the Windows ROCm binary which was not written well.
- Windows ROCm support is... problematic and currently requires for the user to manually add the installed ROCm bin directory to the system PATH. In particular "hipInfo.exe" must be present, which is not always the case for older verions of ROCm.
## Future Considerations
- migrate the project to Tauri from Electron?

View file

@ -38,7 +38,7 @@
},
"license": "AGPL-3.0-or-later",
"devDependencies": {
"@eslint/js": "^9.34.0",
"@eslint/js": "^9.35.0",
"@types/node": "^24.3.1",
"@types/react": "^19.1.12",
"@types/react-dom": "^19.1.9",
@ -49,7 +49,7 @@
"electron": "^38.0.0",
"electron-builder": "^26.0.12",
"electron-vite": "^4.0.0",
"eslint": "^9.34.0",
"eslint": "^9.35.0",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-no-comments": "^1.1.10",
"eslint-plugin-react": "^7.37.5",

View file

@ -594,14 +594,14 @@ __metadata:
languageName: node
linkType: hard
"@eslint-community/eslint-utils@npm:^4.2.0, @eslint-community/eslint-utils@npm:^4.7.0":
version: 4.7.0
resolution: "@eslint-community/eslint-utils@npm:4.7.0"
"@eslint-community/eslint-utils@npm:^4.7.0, @eslint-community/eslint-utils@npm:^4.8.0":
version: 4.8.0
resolution: "@eslint-community/eslint-utils@npm:4.8.0"
dependencies:
eslint-visitor-keys: "npm:^3.4.3"
peerDependencies:
eslint: ^6.0.0 || ^7.0.0 || >=8.0.0
checksum: 10c0/c0f4f2bd73b7b7a9de74b716a664873d08ab71ab439e51befe77d61915af41a81ecec93b408778b3a7856185244c34c2c8ee28912072ec14def84ba2dec70adf
checksum: 10c0/33b93d2a4e9d5fe4c11d02d0fc5ed69e12fcb1e7ca031ded0d6adb24e768c36df77288ed79eecc784f9db34219816247db27688dfe869fb7fbf096840a097d7a
languageName: node
linkType: hard
@ -656,10 +656,10 @@ __metadata:
languageName: node
linkType: hard
"@eslint/js@npm:9.34.0, @eslint/js@npm:^9.34.0":
version: 9.34.0
resolution: "@eslint/js@npm:9.34.0"
checksum: 10c0/53f1bfd2a374683d9382a6850354555f6e89a88416c34a5d34e9fbbaf717e97c2b06300e8f93e5eddba8bda8951ccab7f93a680e56ded1a3d21d526019e69bab
"@eslint/js@npm:9.35.0, @eslint/js@npm:^9.35.0":
version: 9.35.0
resolution: "@eslint/js@npm:9.35.0"
checksum: 10c0/d40fe38724bc76c085c0b753cdf937fa35c0d6807ae76b2632e3f5f66c3040c91adcf1aff2ce70b4f45752e60629fadc415eeec9af3be3c274bae1cac54b9840
languageName: node
linkType: hard
@ -3164,17 +3164,17 @@ __metadata:
languageName: node
linkType: hard
"eslint@npm:^9.34.0":
version: 9.34.0
resolution: "eslint@npm:9.34.0"
"eslint@npm:^9.35.0":
version: 9.35.0
resolution: "eslint@npm:9.35.0"
dependencies:
"@eslint-community/eslint-utils": "npm:^4.2.0"
"@eslint-community/eslint-utils": "npm:^4.8.0"
"@eslint-community/regexpp": "npm:^4.12.1"
"@eslint/config-array": "npm:^0.21.0"
"@eslint/config-helpers": "npm:^0.3.1"
"@eslint/core": "npm:^0.15.2"
"@eslint/eslintrc": "npm:^3.3.1"
"@eslint/js": "npm:9.34.0"
"@eslint/js": "npm:9.35.0"
"@eslint/plugin-kit": "npm:^0.3.5"
"@humanfs/node": "npm:^0.16.6"
"@humanwhocodes/module-importer": "npm:^1.0.1"
@ -3210,7 +3210,7 @@ __metadata:
optional: true
bin:
eslint: bin/eslint.js
checksum: 10c0/ba3e54fa0c8ed23d062f91519afaae77fed922a6c4d76130b6cd32154bcb406aaea4b3c5ed88e0be40828c1d5b6921592f3947dbdc5e2043de6bd7aa341fe5ea
checksum: 10c0/798c527520ccf62106f8cd210bd1db1f8eb1b0e7a56feb0a8b322bf3a1e6a0bc6dc3a414542c22b1b393d58d5e3cd0252c44c023049de9067b836450503a2f03
languageName: node
linkType: hard
@ -3635,7 +3635,7 @@ __metadata:
version: 0.0.0-use.local
resolution: "gerbil@workspace:."
dependencies:
"@eslint/js": "npm:^9.34.0"
"@eslint/js": "npm:^9.35.0"
"@mantine/core": "npm:^8.2.8"
"@mantine/hooks": "npm:^8.2.8"
"@types/node": "npm:^24.3.1"
@ -3649,7 +3649,7 @@ __metadata:
electron: "npm:^38.0.0"
electron-builder: "npm:^26.0.12"
electron-vite: "npm:^4.0.0"
eslint: "npm:^9.34.0"
eslint: "npm:^9.35.0"
eslint-plugin-import: "npm:^2.32.0"
eslint-plugin-no-comments: "npm:^1.1.10"
eslint-plugin-react: "npm:^7.37.5"