Skip to content

Docs/update readme and requirements #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulysse-bouchet-simvia merged 3 commits into from
Apr 28, 2026
+8 −1
Merged

Docs/update readme and requirements #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fed0f2
docs: bump minimum Python requirement to 3.10 in README
basile-simvia Apr 28, 2026
e8ad1b8
docs: add installation video tutorials for Linux and Windows
basile-simvia Apr 28, 2026
fdb319c
docs: add features demo GIF to README
basile-simvia Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ It offers:
- Advanced features for editing `.comm` files
- A fully integrated 3D Visualizer to explore your meshs

![VS Code Aster demo](media/images/vscode_aster.gif)

## Installation

### 1. Installing the extension
Expand Down Expand Up @@ -55,7 +57,7 @@ The **VS Code Aster** extension is now available on the [VS Code Marketplace](ht

### 2. Required dependencies

This extension requires **Python 3.8 or later** and the following packages :
This extension requires **Python 3.10 or later** and the following packages :

- `numpy`
- `pygls==1.3.1`
Expand Down Expand Up @@ -105,6 +107,11 @@ If you'd like to run simulations, you need to have **cave** installed on your sy

You're now ready to use **VS Code Aster** !

### Video tutorials

- [Installing VS Code Aster on Linux](https://www.youtube.com/watch?v=hfgOAKXF4d8)
- [Installing and configuring VS Code Aster on Windows (native code_aster)](https://www.youtube.com/watch?v=-Nmcb2MnmHU)

## Features overview

### 1. Creating and managing .export files
Expand Down
Binary file added media/images/vscode_aster.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading