Skip to content

revert readme (no --venv option yet) #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
remytuyeras merged 1 commit into from
Dec 26, 2025
Merged

revert readme (no --venv option yet) #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,36 +72,27 @@ Once Python and Rust are installed, clone the repo and initialize the environmen
```bash
git clone https://github.com/Summoner-Network/summoner-core.git
cd summoner-core
source setup.sh # optional flags: [--uv] [--server <prefix>] [--venv <path>] (see below)
source setup.sh # optional flags: [--uv] [--server <prefix>] (see below)
```

Optional flags for `source setup.sh`:

* `--uv` uses `uv` instead of `pip` and requires `uv` on `PATH`.
* `--server <prefix>` selects which Rust servers to (re)install by prefix. The prefix is appended to `rust_server_`. Any crate starting with `rust_server_<prefix>` will be installed. Default prefix is `v1_0_0`.
* `--venv <path>` selects which virtual environment to use. This lets you use `venv/`, `.venv/`, or any custom name. If omitted, the default is `venv/` unless you already activated a venv (in which case the active `$VIRTUAL_ENV` is used).

Examples:

```bash
source setup.sh --uv
source setup.sh --server v1_ # installs all rust_server_v1_* crates if present
source setup.sh --uv --server v1_1_0 # installs rust_server_v1_1_0 only

# Flexible venv naming
python3 -m venv .venv
source .venv/bin/activate
source setup.sh --uv # uses the active venv via $VIRTUAL_ENV

# Or explicitly select a venv path (no need to pre-activate)
source setup.sh --venv .venv --uv
```

The `setup.sh` script performs the following actions:

**Python environment**

* Creates and activates a Python virtual environment (default: `venv/`).
* Creates and activates a Python virtual environment at `venv/`.
* Installs core Python build tooling: `setuptools`, `wheel`, `maturin`.
* Uses `pip` by default, or `uv` when `--uv` is set.

Expand Down