Skip to content

Commit b54d579

Browse files
committed
update README
1 parent eaed758 commit b54d579

File tree

2 files changed

+57
-8
lines changed

2 files changed

+57
-8
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,17 @@ All notable changes to the "robotcode" extension will be documented in this file
55
## [Unreleased]
66

77
### added
8-
- added section about style customization to README.md
8+
- extend README.md
9+
- added section about style customization
10+
- extend feature description
11+
912
- added file icons for robot files
1013
- starting with VSCode Version 1.64, if the icon theme does not provide an icon for robot files, this icon is used
1114
- add automatic debug configurations
1215
- you don't need to create a launch.json to run tests in the debugger view
1316
- correct step-in FINALLY in debugger
17+
- test explorer activates now only if there are robot files in workspace folder
18+
1419

1520
## 0.5.0
1621

README.md

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,69 @@ Extensions installed through the marketplace are subject to the [Marketplace Ter
1616

1717
## Features
1818

19-
With RobotCode you can edit your code with auto-completion, code navigation, syntax checking and more.
19+
With RobotCode you can edit your code with auto-completion, code navigation, syntax checking and many more.
20+
Here is a list of Features:
21+
22+
- [Autocomplete and IntelliSense](#Autocomplete-and-IntelliSense)
23+
- [Code Navigation](#code-navigation)
24+
- [Diagnostics]()
25+
- [Diagnostics and Linting](#diagnostics-and-linting)
26+
- [Code Formatting](#code-formatting)
27+
- [Running and Debugging](#running-and-debugging)
28+
- [Multi-root Workspace folders](#multi-root-workspace-folders)
29+
- Test Explorer
30+
- and many more
2031

2132
### Autocomplete and IntelliSense
2233

34+
Autocompletion for:
2335
- Library with parameters
24-
- Resources, Variables
36+
- Resources,
37+
- Variables
2538
- Keywords with parameters
39+
- Namespaces
2640

2741
![Autocomplete Libraries and Keywords](./doc/images/autocomplete1.gif)
2842

29-
- Variables
43+
Autocompletion supports all supported variables types
3044
- local variables
3145
- variables from resource files
3246
- variables from variables file (.py and .yaml)
47+
- static and dynamic
3348
- command line variables
3449
- builtin variables
3550

3651
![Autocomplete Variables](./doc/images/autocomplete2.gif)
3752

38-
### Linting
53+
### Code Navigation
54+
55+
- Symbols
56+
- Goto definitions and implementations
57+
- Keywords
58+
- Variables
59+
- Libraries
60+
- Resources
61+
- Find references
62+
- Keywords
63+
- Variables
64+
- Imports
65+
- Libraries
66+
- Resources
67+
- Variables
68+
- Errors and Warnings
69+
### Diagnostics and Linting
70+
71+
RobotCode analyse your code and show diagnostics for:
72+
- Syntax Errors
73+
- Unknown keywords
74+
- Duplicate keywords
75+
- Missing libraries, resource and variable imports
76+
- Duplicate libraries, resource and variable imports
77+
- ... and many more
78+
79+
For most things RobotCode uses the installed RobotFramework version to parse and analyse the code, so you get the same errors as when you run it.
80+
3981

40-
RobotCode analyse your code for missing libraries, keywords, duplicate imports and many more.
4182
Get addition code analysis with [Robocop](https://robocop.readthedocs.io/). Just install it in your python environment.
4283

4384
### Code Formatting
@@ -52,7 +93,10 @@ RobotCode supports running and debugging of RobotFramework testcases and tasks o
5293

5394
In the debug console you can see all log messages of the current run and navigate to the keyword the message was written by.
5495

55-
TODO
96+
### Multi-root Workspace folders
97+
98+
RobotCodes support for [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), enables loadin and editing different Robotframework projects/folders with different RobotFramework/Python environments and settings at the same time or use can share the same RobotFramework/Python environment and settings for all folders in the workspace.
99+
56100

57101
## Quick start
58102

@@ -97,7 +141,7 @@ This is the simpliest way to create an running environment.
97141

98142
### Editor Style
99143

100-
You can change some stylings for RobotFramework files in VSCode editor (see [Customizing a Color Theme](https://code.visualstudio.com/docs/getstarted/themes#_customizing-a-color-theme))
144+
You can change some stylings for RobotFramework files in VSCode editor, independently of the current theme. (see [Customizing a Color Theme](https://code.visualstudio.com/docs/getstarted/themes#_customizing-a-color-theme))
101145

102146
See the difference:
103147

0 commit comments

Comments
 (0)