From 4881440c6d59047c2ceb07b3ecf483173b5c6074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 29 Sep 2023 14:13:59 +0200 Subject: [PATCH] add link to and info on extensions.json --- entries/software.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/entries/software.md b/entries/software.md index dd69d12e..46a4fad7 100644 --- a/entries/software.md +++ b/entries/software.md @@ -3,6 +3,7 @@ title: "Software we use" --- ## Software + These are the software we use as a team: - IDEs: @@ -15,31 +16,32 @@ These are the software we use as a team: - [Docker](https://docs.docker.com/get-docker/) - [Python 3](https://www.python.org/downloads/) - [Discord](https://discord.com/download) +- [Quarto](https://quarto.org/docs/get-started/) These are the recommended helper or workflow type software: - [GitHub CLI](https://cli.github.com/manual/) +## Recommended VS Code Extensions -## Recommended VS Code Extensions -If you are not familiar with VS Code extensions, they are add-ons or plugins that enhance the -functionality of VS Code. They can be installed to customize and extend the capabilities of -VS Code to support a wide range of programming languages, frameworks, and development tasks. - -Go to the extensions tab in VS Code and search for the following extensions: +If you are using VS Code, but are not familiar with extensions, they are add-ons or plugins +that enhance the functionality of VS Code. They can be installed to customize and extend the +capabilities of VS Code to support a wide range of programming languages, frameworks, and +development tasks. -- [Quarto](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) (to enable preview the website) - - To use this extension, you will need to download [Quarto](https://quarto.org/docs/get-started/) -- [PlantUML](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) (to enable preview of puml diagrams) -- Dev Containers?? -- markdownlint or something similar?? +In the [extensions.json](https://github.com/seedcase-project/seedcase-project/blob/main/.vscode/extensions.json) +in the seedcase-project repository, you will find the extensions we recommend for working +in that workspace. When you clone the seedcase-project repository and open the repository +folder in VS Code, a pop-up message will recommend the extensions in this file. +We recommend that you install these. -**Python Extensions** (*draft* - Signe have used these earlier, but will check up on which should be recommended here) +**Python Extensions** (*draft* - Signe have used these earlier, but will check up on +which should be recommended here) - [python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - [isort](https://marketplace.visualstudio.com/items?itemName=ms-python.isort) - [Black Formatter](https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter) -- [autoDocstring]() +- [autoDocstring](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) - [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) - [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) -- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- [pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)