Skip to content

Commit 8436ade

Browse files
committed
Update Readme and Changelog
1 parent 54053e3 commit 8436ade

File tree

3 files changed

+24
-38
lines changed

3 files changed

+24
-38
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ All notable changes to the "robotcode" extension will be documented in this file
44

55
## [Unreleased]
66

7+
## 0.2.1
8+
79
### added
810

911
- improve test run messages

README.md

Lines changed: 21 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,29 @@
1-
# Robot Code Readme
2-
3-
RobotFramework Language Server and client for Visual Studio Code.
1+
# RobotCode
42

3+
An [extension](https://marketplace.visualstudio.com/VSCode) which brings support for [RobotFramework](https://robotframework.org/) to [Visual Studio Code](https://code.visualstudio.com/), including features like IntelliSense, linting, debugging, code navigation, code formatting, test explorer, and more!
54

65
## Requirements
76

87
* Python 3.8 or above
98
* Robotframework 4.0 and above
109
* VSCode version 1.60 and above
1110

12-
## Installation
13-
14-
At the moment, it is only possible to install the vsix manually in VSCode.
15-
Download the vscode-package artifact from the latest [CI/Actions](https://github.com/d-biehl/robotcode/actions/workflows/build.yml) run and install the containing vsix file manually in VSCode.
16-
17-
## Features
18-
19-
* Syntax Highlighting
20-
* Semantic highlighting (comming soon)
21-
* Syntax Analysis
22-
* also for 'run keyword(s) (if/unless/...)'
23-
* live updating if library or resources changed
24-
* Integrate 'Robocop' tool static code analysis of Robot Framework code.
25-
* https://github.com/MarketSquare/robotframework-robocop
26-
* Code Completion
27-
* Headers
28-
* Settings
29-
* Keywords
30-
* Parameter names for:
31-
* Keywords
32-
* Libraries
33-
* Libraries
34-
* Python Modules
35-
* Python Files
36-
* Resources
37-
* Signature Help
38-
* Goto Definition
39-
* Folding
40-
* Hover Information
41-
* Document Symbols
42-
* Loading Library/Resources with support for builtin variables
43-
* Support for VSCode test explorer
44-
45-
... more comming soon
11+
## Installed extensions
12+
13+
RobotCode will automatically install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python).
14+
15+
Extensions installed through the marketplace are subject to the [Marketplace Terms of Use](https://cdn.vsassets.io/v/M146_20190123.39/_content/Microsoft-Visual-Studio-Marketplace-Terms-of-Use.pdf).
16+
17+
## Quick start
18+
19+
1. [Install a supported version of Python on your system](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites)
20+
(note: only Python 3.8 and above are supported)
21+
22+
2. [Install a supported version of RobotFramwork on your system](https://github.com/robotframework/robotframework/blob/master/INSTALL.rst) (note: only RobotFramework 4.0 and above are supported)
23+
24+
3. [Install the # RobotCode extension for Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-gallery).
25+
4. Open or create a robot file and start coding! 😉
26+
27+
## Setting up your environment
28+
29+
TODO

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
22
name = "robotcode"
33
version = "0.2.0"
4-
description = "RobotCode language server,debugger and tools for RobotFramework"
4+
description = "Language server,debugger and tools for RobotFramework"
55
authors = ["Daniel Biehl <[email protected]>"]
66
include = ["robotcode/py.typed", "README.md"]
77
exclude = ["robotcode/external"]

0 commit comments

Comments
 (0)