Skip to content

Commit 3ffb84d

Browse files
ahmadzeinclaude
andcommitted
docs: Update GUI launch instructions in README and INSTALL.md
- Added instructions for rebuilding native modules for Electron - Removed "not implemented yet" note from GUI command - Added troubleshooting note for GUI issues 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 2de6976 commit 3ffb84d

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

INSTALL.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,15 @@ portman kill 3000
6262

6363
### GUI
6464
```bash
65-
# Launch the GUI (not implemented yet)
65+
# Launch the GUI
6666
portman gui
6767
```
6868

69+
If you encounter issues with the GUI, rebuild the native modules:
70+
```bash
71+
npm rebuild better-sqlite3 --runtime=electron --target=28.0.0
72+
```
73+
6974
## Troubleshooting
7075

7176
### Command not found

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,11 @@ Launch the GUI application:
8383
portman gui
8484
```
8585

86-
Or use the desktop application directly after installation.
86+
**Note**: The GUI feature requires the project to be built first. If you encounter issues, run:
87+
```bash
88+
npm run build:gui
89+
npm rebuild better-sqlite3 --runtime=electron --target=28.0.0
90+
```
8791

8892
## Development
8993

0 commit comments

Comments
 (0)