Skip to content

Commit d10644e

Browse files
committed
Updating Reqs2x documentation
1 parent 668d7c5 commit d10644e

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

docs/reqs2x/reqs2x_documentation.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,31 @@ This manual demonstrates Reqs2x usage workflows from inside this VS-Code extensi
1919

2020

2121
### Prerequisites
22-
1. **Uninstall Previous Versions**: Remove any existing versions of the VectorCAST VS-Code extension.
23-
2. **Prepare Reqs2x Core**:
22+
Remove any existing versions of the VectorCAST VS-Code extension.
23+
24+
#### If you are using a demo release:
25+
1. **Prepare Reqs2x Core**:
2426
* Extract the Reqs2x core release (`autoreq-win.tar.gz` or `autoreq-linux.tar.gz`).
2527
* Locate the `bin` folder (executables) and `TUTORIAL_C` folder (demo environment).
26-
3. **License Setup**: Ensure your VectorCAST license is configured. Ideally, point `VECTORCAST_DIR` to your release.
27-
4. **Open Project**: Open a terminal and navigate to the extracted `autoreq-win/distribution/TUTORIAL_C` directory.
28+
2. **License Setup**: Ensure your VectorCAST license is configured. Point `VECTORCAST_DIR` to your release.
29+
3. **Open Project**: Open a terminal and navigate to the extracted `autoreq-win/distribution/TUTORIAL_C` directory, then open it in VS-Code.
30+
31+
#### If you are using VectorCAST 2026:
32+
1. **License Setup**: Ensure your VectorCAST license is configured. Point `VECTORCAST_DIR` to your release.
33+
2. **Open Project**: Create a new directory named `TUTORIAL_C` and copy the contents of `$VECTORCAST_DIR/tutorial/c` directory into it, then open it in VS-Code.
34+
2835

2936
### VS Code Extensions
30-
1. Install the **Excel Viewer** extension (`GrapeCity.gc-excelviewer`) to view/edit Excel sheets directly in VS Code.
37+
1. Install the **Excel Viewer** extension (`GrapeCity.gc-excelviewer`) to view/edit Excel sheets directly in VS Code (optional). Alternatively, use MS Excel to view/edit Excel sheets.
3138
2. Install the **VectorCAST Text Explorer** VS-Code extension from the Microsoft Marketplace.
3239

3340
### Configuration
3441
1. Activate the extension: Press `Ctrl+Shift+P`, search for **Vectorcast Test Explorer**, and press `Enter`.
3542
2. Open the **Settings** tab (opens automatically).
3643
3. Configure the following settings:
37-
* **Vectorcast Test Explorer › Reqs2x: Installation Location**: Point this to the `autoreq-win/distribution/bin` folder you extracted earlier.
44+
* **Vectorcast Test Explorer › Reqs2x: Installation Location**:
45+
- If you are using a demo release, point this to the `autoreq-win/distribution/bin` folder you extracted earlier.
46+
- If you are using VectorCAST 2026, point this to your VectorCAST release folder ($VECTORCAST_DIR)
3847
* **Vectorcast Test Explorer › Reqs2x: Provider**:
3948
Select the large language model provider you intend to use from the dropdown menu
4049
* **Note**: Most providers support the `openai` API. This includes `Google`, `AWS Bedrock`, as well as open-source model-serving methods like `ollama`, `vLLM` and `SG-Lang`. Use [LiteLLM](https://github.com/BerriAI/litellm) for any provider not supporting `openai`/`openai_azure` API.

0 commit comments

Comments
 (0)