From c2a9ed9cd85b1b2bd5e4b566059c4a16fa57de5d Mon Sep 17 00:00:00 2001 From: Patrick Tanner Date: Thu, 18 Jun 2020 14:01:23 +0200 Subject: [PATCH] Started writing README --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6f8be97..5cacdf5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ -# vscode-brAutomationTools -VS Code extension to edit B&R Automation Studio projects. This is extension was not created officially be B&R Automation, but is a private experiment. +# B&R Automation Tools -# vscode-brautomationtools README +B&R Automation Tools is an extension for [Visual Studio Code](https://code.visualstudio.com) to program and build B&R Automation Studio prjects. -This is the README for your extension "vscode-brautomationtools". After writing up a brief description, we recommend including the following sections. +The B&R Automation Tools extension is NOT a product of [B&R Industrial Automation GmbH](https://www.br-automation.com), it is a privately written and inofficial experiment. + +For most of the functionality a B&R Automation Studio needs to be installed on the develeoper PC currently. ## Features +### Detecting installed B&R Automation Studio versions + +TODO + +### Detecting B&R Automation Studio projects in the workspace folders + +TODO + +### Build B&R Automation Studio projects + +TODO + +### Auto completion for C/C++ programs and libraries + +TODO + +# Standard VS Code readme contents TODO write for the extension + Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. For example if there is an image subfolder under your extension project workspace: