diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 81915b1..09a72af 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -4,7 +4,7 @@ "version": "2.0.0", "tasks": [ { - "label": "Python Requirements", + "label": "Install Python Requirements", "type": "shell", "command": [ "pip", @@ -13,19 +13,19 @@ "requirements.txt" ], "group": { - "kind": "requirements" + "kind": "none" }, "problemMatcher": [] }, { - "label": "NPM Requirements", + "label": "Install NPM Requirements", "type": "shell", "command": [ "npm", "install" ], "group": { - "kind": "requirements" + "kind": "none" }, "problemMatcher": [] }, @@ -38,7 +38,7 @@ "NPM Requirements" ], "group": { - "kind": "requirements" + "kind": "none" }, "problemMatcher": [] }, @@ -71,7 +71,7 @@ "_build" ], "problemMatcher": [] - } + }, { "label": "Build and open", "type": "shell", diff --git a/README.md b/README.md index 2aa9ea0..c0ddd85 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,23 @@ This is the documentation for the NewTec Git Work Instructions. You can find the 5. Build the documentation: `sphinx-build doc _build --fail-on-warning` 6. Open the documentation: `_build/index.html` +### Visual Studio Code Tasks + +If you are using VSCode, the commands mentioned above are packed into tasks, making it easier for the developer to use. + +1. Clone the repository: `git clone https://github.com/NewTec-GmbH/gitWorkInstructions.git` +2. Open the folder with VSCode: `code ./gitWorkInstructions` +3. On the top menu, choose `Terminal` -> `Run Task...` and select the task you require. + +#### Available Tasks + +* Install Python Requirements +* Install NPM Requirements +* Install all requirements +* Build +* Clean +* Build and open + ## Used Libraries Used 3rd party libraries which are not part of the standard Python package: