Skip to content

Commit dec3a6a

Browse files
committed
Update README.md to reflect changes in command-line arguments and improve clarity on project directory paths for the WebSocket server setup.
1 parent d0e9fc4 commit dec3a6a

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,14 @@ npm install
3030
```bash
3131
npm start -- \
3232
--port 9011 \
33-
--project-root /path/to/project \
34-
--jesse-relative-path jesse_folder_name \
35-
--bot-relative-path jesse-bot_folder_name
33+
--bot-root /path/to/jesse-bot \
34+
--jesse-root /path/to/jesse
3635
```
3736

3837
### Command-Line Arguments
39-
- `--port` - WebSocket server port (default: 9011)
40-
- `--project-root` - Root directory of the Python project
41-
- `--jesse-relative-path` - Relative path to Jesse framework folder
42-
- `--bot-relative-path` - Relative path to Jesse bot folder
38+
- `--port` - WebSocket server port (required)
39+
- `--bot-root` - Absolute path to the Jesse bot root directory (required)
40+
- `--jesse-root` - Absolute path to the Jesse framework root directory (required)
4341

4442
## Build
4543

@@ -69,9 +67,8 @@ tar -xzf linux-x64.tar.gz
6967
cd linux-x64
7068
./start.sh \
7169
--port 9011 \
72-
--project-root /path/to/project \
73-
--jesse-relative-path jesse_folder_name \
74-
--bot-relative-path jesse-bot_folder_name
70+
--bot-root /path/to/jesse-bot \
71+
--jesse-root /path/to/jesse
7572
```
7673

7774
### Windows
@@ -80,12 +77,12 @@ REM Extract win32-x64.zip
8077
8178
REM Run the server
8279
cd win32-x64
83-
start.bat --port 9011 --project-root C:\path\to\project --jesse-relative-path jesse_folder_name --bot-relative-path jesse-bot_folder_name
80+
start.bat --port 9011 --bot-root C:\path\to\jesse-bot --jesse-root C:\path\to\jesse
8481
```
8582

8683
## Configuration
8784

88-
The Pyright language server is configured via `pyrightconfig.json` in the project root. You can customize type checking behavior, Python version, include/exclude patterns, and more.
85+
The Pyright language server is configured via `pyrightconfig.json`. The bridge automatically deploys this configuration file to the bot root directory specified by `--bot-root` on startup. You can customize type checking behavior, Python version, include/exclude patterns, and more.
8986

9087
## Features
9188

0 commit comments

Comments
 (0)