Skip to content

Commit 2eca4fb

Browse files
refactor: readme updates
1 parent 443994e commit 2eca4fb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The **TestBench Extension** enables seamless synchronization between [TestBench]
55
## Key Features
66

77
- **Project Navigation**: Browse TestBench projects, including Subdivisions, keywords, and Test Theme Trees
8-
- **Keyword Synchronization**: Bidirectionally synchronize Robot Framework keywords with keywords in TestBench
8+
- **Keyword Synchronization**: Bidirectionally synchronize Robot Framework keywords with TestBench keywords
99
- **Test Generation**: Automatically generate Robot Framework test suites from TestBench test case sets
1010
- **Result Import**: Upload Robot Framework execution results directly back to TestBench
1111

@@ -35,17 +35,17 @@ The following extensions are automatically installed as dependencies when you in
3535
### Link a TestBench Project to the Workspace/Folder Opened in VS Code
3636

3737
A workspace or folder in VS Code must always be linked to a specific Test Object Version in TestBench. Only after creating such a link you will be able to use all features of the extension, including the synchronization of Robot Framework keywords.
38-
To link a TestBench Project to the opened workspace/folder, simply right-click on the desired Test Object Version in the Projects view and select "Set as Active TOV".
38+
To link a TestBench Project to the currently opened workspace/folder, simply right-click on the desired Test Object Version in the Projects view and select "Set as Active TOV".
3939

4040
![Link VS Code Workspace to Test Object Version](userGuideImages/link_tov.gif)
4141

4242
### Create a Robot Framework Resource File from a TestBench Subdivision
4343

4444
For a TestBench Subdivision to be visible in the TestBench extension, the Subdivision name must end with the suffix `[Robot-Resource]`. Subdivisions that do not follow this naming convention are ignored by the extension.
4545

46-
![Edit Subdivision Suffix to display them in the extension](userGuideImages/subdivision_suffix.png)
46+
![Edit Subdivision Suffix to display it in the extension](userGuideImages/subdivision_suffix.png)
4747

48-
To create a Robot Framework resource file from a TestBench Subdivision, simply hover over the corresponding Subdivision in the `Test Elements` view and click the `Create Resource` button. Afterwards, you can use the test elements view of the extension to navigate between keywords and resource files.
48+
To create a Robot Framework resource file from a TestBench Subdivision, simply hover over the corresponding Subdivision in the `Test Elements` view and click the `Create Resource` button. Afterwards, you can use the `Test Elements` view of the extension to navigate between keywords and resource files.
4949
The path where the resource file is created can be configured in the extension settings.
5050

5151
![Create Resource from TestBench Subdivision](userGuideImages/create_resource.gif)
@@ -81,22 +81,22 @@ Auto Auswählen
8181

8282
As shown in the example above, each keyword that is synchronized with TestBench must have a tag with the format `tb:uid:<Keyword-UID>` where `<Keyword-UID>` is the UID of the corresponding TestBench keyword.
8383

84-
With the required metadata in place, you can now use the CodeLens actions to push or pull keywords between VS Code and TestBench. You can also use the code lens at the top of the file to push or pull all keywords in the file at once.
84+
With the required metadata in place, you can now use the CodeLens actions to push or pull keywords between VS Code and TestBench. You can also use the CodeLens at the top of the file to push or pull all keywords in the file at once.
8585

8686
![Synchronize Robot Framework Keywords with TestBench](userGuideImages/sync_keywords.gif)
8787

8888
If there is no uid tag in a keyword, the CodeLens action will allow you to **create** a new keyword in TestBench with the specified name and interface.
8989

90-
### Generate Robot Framework Tests from TestBench Testcases
90+
### Generate Robot Framework Tests from TestBench Test Cases
9191

92-
After using the Robot Framework keywords within TestBench Testcases to specify the test logic, you can generate Robot Framework test suites from the Testcases defined in TestBench.
93-
The generated Robot Framework test suites will be created in your workspace/folder and can afterwards be executed or debugged. To generate Robot Framework tests, simply hover over the desired Testcase in the `Test Themes` view and click the `Generate Robot Framework Test Suites` button. The path where the test suites are created and the format of the tests can be configured in the extension settings. Please note that depending on which test cycle or test object version is opened in the extension, different testcases will be generated.
92+
After using the Robot Framework keywords within TestBench test cases to specify the test logic, you can generate Robot Framework test suites from the test cases defined in TestBench.
93+
The generated Robot Framework test suites will be created in your workspace/folder and can then be executed or debugged. To generate Robot Framework tests, simply hover over the desired test case in the `Test Themes` view and click the `Generate Robot Framework Test Suites` button. The path where the test suites are created and the format of the tests can be configured in the extension settings. Please note that depending on which test cycle or Test Object Version is opened in the extension, different test cases will be generated.
9494

9595
![Generate Robot Framework Tests](userGuideImages/generate_tests.png)
9696

9797
### Upload Execution Results Back to TestBench
9898

99-
After executing the generated Robot Framework test suites, you can import the execution results back to TestBench. To do so, simply hover over the desired Testcase in the `Test Themes` view and click the `Upload Execution Results To TestBench` button. The extension will then look for the corresponding Robot Framework output files in the configured output directory and import the results back to TestBench. Please note that execution results can only be imported if the test suites have been generated from a Test Cycle in TestBench (not a Test Object Version).
99+
After executing the generated Robot Framework test suites, you can import the execution results back to TestBench. To do so, simply hover over the desired test case in the `Test Themes` view and click the `Upload Execution Results To TestBench` button. The extension will then look for the corresponding Robot Framework output files in the configured output directory and import the results back to TestBench. Please note that execution results can only be imported if the test suites have been generated from a Test Cycle in TestBench (not a Test Object Version).
100100

101101
![Upload Execution Results to TestBench](userGuideImages/upload_results.png)
102102

@@ -107,7 +107,7 @@ To make the VS Code extension trust a custom or self-signed certificate from you
107107
### How to set it:
108108

109109
- Obtain the public certificate file (.pem) from your TestBench server.
110-
- In the extension settings, set Certificate Path.
110+
- In the extension settings, set the Certificate Path.
111111

112112
<!-- ## Documentation
113113

0 commit comments

Comments
 (0)