apunkt/flakestorm
1
0
Fork 0
mirror of https://github.com/flakestorm/flakestorm.git synced 2026-04-25 00:36:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance installation instructions across documentation to emphasize the use of virtual environments for Python. Added details for creating and activating virtual environments in README.md, CONTRIBUTING.md, TEST_SCENARIOS.md, TESTING_GUIDE.md, and USAGE_GUIDE.md. Included pipx installation instructions for CLI use in USAGE_GUIDE.md.

Browse source
This commit is contained in:
Entropix 2025-12-30 18:02:36 +08:00
parent bc0abff246
commit cb034b41ff
5 changed files with 61 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -48,10 +48,25 @@ Instead of running one test case, Flakestorm takes a single "Golden Prompt", gen
### Installation
**Using a virtual environment (recommended):**
```bash
# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install flakestorm
pip install flakestorm
```
**Or using pipx (for CLI use only):**
```bash
pipx install flakestorm
```
**Note:** Requires Python 3.10 or higher. On macOS, Python environments are externally managed, so using a virtual environment is required.
### Prerequisites
Flakestorm uses [Ollama](https://ollama.ai) for local model inference: