Skip to content

Commit

Permalink
more install instructions updates
Browse files Browse the repository at this point in the history
  • Loading branch information
enarjord committed Oct 16, 2024
1 parent b75a16c commit ef85bb4
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,17 +75,17 @@ Install all the required Python dependencies listed in the `requirements.txt` fi
pip install -r requirements.txt
```

### Step 5: Build Rust Extensions
### Step 5 (optional): Build Rust Extensions

Navigate to the `passivbot-rust` directory and build the Rust extensions using `maturin`:
Passivbot will attempt to build the necessary Rust extensions automatically, but they can also be built manually by navigating to the `passivbot-rust` directory and using `maturin`:

```sh
cd passivbot-rust
maturin develop --release
cd ..
```

Note that the Rust bindings must be recompiled for changes in the Rust source to take effect.
If changes in the Rust source are detected, recompilation is needed, which Passivbot will attempt to do automatically when starting. To manually recompile, use the commands given above.

### Step 6: Add API keys

Expand All @@ -97,19 +97,19 @@ cp api-keys.json.example api-keys.json

Add your keys to api-keys.json.

### Step 6: Run Passivbot
### Step 7: Run Passivbot

To start the bot with the default settings, run:

```sh
python src/main.py -u {account_name_from_api-keys.json}
python3 src/main.py -u {account_name_from_api-keys.json}
```

or make a new configuration file, using `configs/template.json` as a template.
or make a new configuration file, using `configs/template.json` as a template, and start the bot with:


```sh
python src/main.py path/to/config.json
python3 src/main.py path/to/config.json
```

## Jupyter Lab
Expand Down

0 comments on commit ef85bb4

Please sign in to comment.