VQkit 1.1 - START HERE
===========================

1. Use Python 3.9 or newer.
2. Create or activate a virtual environment.
3. Install:

   python -m pip install --upgrade installable/vqkit-1.0-py3-none-any.whl

4. Verify:

   vqkit version

   Expected: VQkit 1.1

5. Start:

   vqkit

Read README.md for the current feature overview.


## Windows PowerShell installation

On Windows, use `python` or the Windows Python launcher `py`. The command `python3` is not always registered on Windows.

First check which command is available:

```powershell
python --version
```

If that is not recognized, try:

```powershell
py --version
```

Create and activate a virtual environment with one of these forms:

```powershell
python -m venv vqkit_env
.\vqkit_env\Scripts\Activate.ps1
```

or:

```powershell
py -m venv vqkit_env
.\vqkit_env\Scripts\Activate.ps1
```

Then install VQkit:

```powershell
python -m pip install --upgrade pip setuptools wheel
python -m pip install --upgrade .\installable\vqkit-1.0-py3-none-any.whl
vqkit version
vqkit
```

Expected version:

```text
VQkit 1.1
```

