Merge branch 'master' into renovate/vscode-languageserver-8.x

README.md

@@ -7,6 +7,7 @@
 ![Lines of code](https://img.shields.io/tokei/lines/github/objectionary/eo-vscode)
 ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/objectionary/eo-vscode/Build/master)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=EOLangVSCode_eo-vscode&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=EOLangVSCode_eo-vscode)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=EOLangVSCode_eo-vscode&metric=coverage)](https://sonarcloud.io/summary/new_code?id=EOLangVSCode_eo-vscode)
 ![GitHub](https://img.shields.io/github/license/objectionary/eo-vscode)
 
 This is the VSCode plugin for [EO](https://github.com/objectionary/eo). It provides semantic highlighting, parsing error checking and EO file icon for your .eo files.
@@ -18,20 +19,38 @@ ext install eolang.eo
 
 You can also install it from [its page](https://marketplace.visualstudio.com/items?itemName=eolang.eo) at Visual Studio Marketplace.
 
+## Structure
+Theis extension is written in **TypeScript**, was developed with **Node 16** and has two main parts: the client and the server. Inside `server/src` yo can find all the code related to the server side. All the code for the client side is located at `client/src`.
+
+The code parser is generated with ANTLR4 using the latest version of the EO grammar located in this [link](https://raw.githubusercontent.com/objectionary/eo/master/eo-parser/src/main/antlr4/org/eolang/parser/Program.g4).
+
+Publishing the extension is done with [Rultor](https://github.com/yegor256/rultor) (see `.rultor.yml`).
+
 ## How to Contribute
-Read the code documentation which can be found [here](https://www.objectionary.com/eo-vscode/)
+Read the code documentation which can be found [here](https://www.objectionary.com/eo-vscode/).
 
 Clone the repository. Install node modules with:
 ```bash
 $ npm install
 ```
 
-Download grammar file and generate ANTLR4 parser with:
+Download grammar file and generate ANTLR4 parser automatically with:
 ```bash
 $ npm run fetch-and-build-grammar
 ```
 
-Make changes on a new branch and create a pull request. To avoid frustration, run:
+Make changes on a new branch. You can run an instance of VSCode with the extension running by hitting F5 in the code editor. After modifications, test your code with:
+```bash
+$ npm run unit-test
+$ npm run end-to-end-test
+```
+
+If you have modified any of the code documentation, generate new documentation files with:
+```bash
+$ npm run generate-docs
+```
+
+Create a pull request. To avoid frustration, run:
 ```bash
 $ npm run linter
 $ npm run compile