Updates README, SECURITY and package.json

Author: gnikit

CHANGELOG.md

@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Updates `README` text and animations, changes `SECURITY` and updates `package.json`
 - Changes the interface of the extension to accommodate for the newest features
   ([#292](https://github.com/krvajal/vscode-fortran-support/issues/292))
 - Changes main parts of the extension to being asynchronous

README.md

@@ -1,103 +1,135 @@
-# Modern Fortran language support for VSCode
+![alt](assets/modern-fortran-logo.png)
 
-[![GitHub Actions](https://github.com/krvajal/vscode-fortran-support/actions/workflows/main.yaml/badge.svg)](https://github.com/krvajal/vscode-fortran-support/actions)
+[![GitHub Actions](https://github.com/fortran-lang/vscode-fortran-support/actions/workflows/main.yaml/badge.svg)](https://github.com/fortran-lang/vscode-fortran-support/actions)
 [![Downloads](https://vsmarketplacebadge.apphb.com/downloads-short/krvajalm.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran)
 [![Installs](https://vsmarketplacebadge.apphb.com/installs/krvajalm.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran)
 [![VS Marketplace](https://vsmarketplacebadge.apphb.com/version-short/krvajalm.linter-gfortran.svg)](https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran)
 [![MIT License](https://img.shields.io/npm/l/stack-overflow-copy-paste.svg?)](http://opensource.org/licenses/MIT)
 
+![alt](assets/intro-demo.gif)
+
 ## Key Features
 
 - Syntax highlighting (Free and Fixed forms)
-- Hover support
-- Autocompletion support
-- Peek/Go to definitions and references
-- Linting support i.e. error wiggles for `gfortran`, `flang` and `ifort`
-- Symbols outline support for functions, subroutines, modules, etc.
-- Native support leveraging the `fortls`
-- Debugger, uses Microsoft's [C/C++ extension](https://github.com/Microsoft/vscode-cpptools)
+- Hover support, Signature help and Auto-completion
+- GoTo/Peek implementation and Find/Peek references
+- Project-wide and Document symbol detection and Renaming
+- Native Language Server integration with [`fortls`](https://github.com/gnikit/fortls)
+- Linting support for `gfortran`, `flang` and `ifort`
+- Debugger [C/C++ extension](https://github.com/Microsoft/vscode-cpptools)
 - Formatting with [findent](https://github.com/gnikit/findent-pypi) or [fprettify](https://github.com/pseewald/fprettify)
 - Code snippets (more can be defined by the user [see](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets))
 
-![alt](./images/intro-demo.gif)
-
-## Settings
+## Language Server integration
 
-You can control the include paths to be used by the linter with the `fortran.linter.includePaths` setting.
-The `linter.includePaths` should match the include requirements for your projects compilation.
+The Fortran Language Server [`fortls`](https://github.com/gnikit/fortls) is responsible
+for providing a lot of the higher level, IDE functionality. By default,
+`Modern Fortran` will attempt to use it for hover, autocompletion, symbols and Go to & Peeking into definitions.
 
-> NOTE: if a glob pattern is used only directories matching the pattern will be included.
+Allow for `fortls` to be automatically installed with `pip` or `Anaconda` and
+if the location where `fortls` is installed is not in your `PATH` point VS Code
+to the `fortls` location by setting
 
-```jsonc
+```json
 {
-  "fortran.linter.includePaths": ["/usr/include/**", "${workspaceFolder}/include/**"]
+  "fortran.fortls.path": "/custom/path/to/fortls"
 }
 ```
 
-By default the `gfortran` executable is assumed to be found in the path. In order to use a different one or if it can't be found in the path you can point the extension to use a custom one with the `fortran.linter.compilerPath` setting.
+For more about the Language Server's capabilities please refer to the
+[documentation](https://gnikit.github.io/fortls/) of `fortls`.
+
+## Linting
+
+Linting allows for compiler error and warning detection while coding
+without the user having to compile.
+
+Using an invalid if expression
+
+![alt](assets/lint-demo.gif)
+
+Using incorrect type and rank as function argument
+
+![alt](assets/lint-demo2.gif)
+
+| :memo: Note                                |
+| ------------------------------------------ |
+| Save your file to generate linting results |
+
+Linting results can be improved by providing additional options to the compiler.
+
+### Including directories
+
+You can control the include paths to be used by the linter with the `fortran.linter.includePaths` option.
+
+| :exclamation: Important                                                                                            |
+| ------------------------------------------------------------------------------------------------------------------ |
+| For the best linting results `linter.includePaths` should match the included paths for your project's compilation. |
 
 ```jsonc
 {
-  "fortran.linter.compilerPath": "/usr/local/bin/gfortran-11.2"
+  "fortran.linter.includePaths": ["/usr/include/**", "${workspaceFolder}/include/**"]
 }
 ```
 
-If you want to pass extra options to the `gfortran` executable or override the default one, you can use the setting `fortran.linter.extraArgs`. Default value is `-Wall` (or `-warn all` for ifort).
+| :exclamation: Important                                                          |
+| -------------------------------------------------------------------------------- |
+| If a glob pattern is used only directories matching the pattern will be included |
+
+### Additional linting options
+
+More options can be passed to the linter via
 
 ```jsonc
 {
-  "fortran.linter.extraArgs": ["-Wall"]
+  "fortran.linter.extraArgs": [
+    "-fdefault-real-8",
+    "-fdefault-double-8",
+    "-Wunused-variable",
+    "-Wunused-dummy-argument"
+  ]
 }
 ```
 
-To show the symbols in the file outline enable `provide.symbols`. Symbols can be
-served by the fortls, the built-in, both or none. By default
-`fortls` is used.
+Default value is `-Wall` (or `-warn all` for ifort).
+
+### Changing linting compiler
+
+By default, the linter used is `gfortran`, Intel's `ifort` and LLVM's `flang` are also supported.
+One can use a different linter compiler via the option
 
 ```jsonc
 {
-  "fortran.provide.symbols": "fortls" | "Built-in" | "Both" | "Disable"
+  "fortran.linter.compiler": "ifort" | "gfortran" | "flang" | "Disabled"
 }
 ```
 
-You can also configure the case for fortran intrinsics auto-complete by using
+The linter executable is assumed to be found in the `PATH`.
+In order to use a different executable or if the executable can't be found in the `PATH`
+you can point the extension to another linter with the `fortran.linter.compilerPath` option.
 
 ```jsonc
 {
-    "fortran.preferredCase": "lowercase" | "uppercase"
+  "fortran.linter.compilerPath": "/opt/oneapi/compiler/2022.0.2/linux/bin/intel64/ifort"
 }
 ```
 
-## Snippets
-
-This is a list of some of the snippets included, if you like to include additional snippets please let me know and I will add them.
-
-### Program skeleton
-
-![program snippet](https://media.giphy.com/media/OYdq9BKYMOOdy/giphy.gif)
-
-#### Module skeleton
-
-![module snippet](https://media.giphy.com/media/3ohzdUNRuio5FfyF1u/giphy.gif)
-
-## Error wiggles
-
-To trigger code validations you must save the file first.
-
 ## Debugging
 
+![alt](assets/gdb_ani.gif)
+
 The extension uses the debugger from Microsoft's
 [C/C++ extension](https://github.com/Microsoft/vscode-cpptools)
 for Visual Studio Code. This allows this extension to use the full functionality
 of the C/C++ extension for debugging applications:
-(un)conditional breaking points, expression evaluation, multi-threaded debugging,
+(un)conditional breaking points, expression evaluation, multithreaded debugging,
 call stack, stepping, watch window.
 
 A minimal `launch.json` script, responsible for controlling the debugger, is
 provided below. However, Visual Studio Code is also capable of autogenerating
 a `launch.json` file and the configurations inside the file.
 
-More details about how to setup the debugger can be found in Microsoft's website:
+More details about how to set up the debugger can be found in Microsoft's website:
 
 - General information about debugging in VS Code: <https://code.visualstudio.com/docs/editor/debugging>
 - C/C++ extension debugger information: <https://code.visualstudio.com/docs/cpp/cpp-debug>
@@ -141,22 +173,22 @@ installed with `pip` automatically through the extension.
 
 |              findent              |              fprettify              |
 | :-------------------------------: | :---------------------------------: |
-| ![alt](./images/findent-demo.gif) | ![alt](./images/fprettify-demo.gif) |
+| ![alt](./assets/findent-demo.gif) | ![alt](./assets/fprettify-demo.gif) |
 
 The formatter is controlled by the user option
 
 ```jsonc
 {
-  "fortran.formatting.formatter": "findent" // "fprettify" or "Disabled"
+  "fortran.formatting.formatter": "findent" | "fprettify" | "Disabled"
 }
 ```
 
 Additional arguments to the formatter can be input using
 
 ```json
 {
-    "fortran.formatting.findentArgs": ["-Cn", "-Rr"],
-    "fortran.formatting.fprettifyArgs": ["--whitespace-comma", "--enable-decl"]
+  "fortran.formatting.findentArgs": ["-Cn", "-Rr"],
+  "fortran.formatting.fprettifyArgs": ["--whitespace-comma", "--enable-decl"]
 }
 ```
 
@@ -168,9 +200,46 @@ If the formatter is not present in the `PATH` its location can be input with
 }
 ```
 
-### NOTE: About `findent`
+| :memo: Note                                                            |
+| ---------------------------------------------------------------------- |
+| `findent` can also be used to generate dependency files for a project. |
+
+## Snippets
+
+Snippets are included by both `fortls` Language Server and the Modern Fortran VS Code extension.
+Some available snippets can be seen below. Users can define their own snippets
+by following these VS Code [instructions](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
+
+If you think a snippet should be shipped by with the extension feel free to
+submit a [feature request](https://github.com/fortran-lang/vscode-fortran-support/issues/new?assignees=&labels=feature-request&template=feature_request.md&title=)
+
+### Program skeleton
+
+![program snippet](https://media.giphy.com/media/OYdq9BKYMOOdy/giphy.gif)
+
+#### Module skeleton
+
+![module snippet](https://media.giphy.com/media/3ohzdUNRuio5FfyF1u/giphy.gif)
+
+## Advanced options
+
+To show the symbols in the file outline enable `provide.symbols`. Symbols can be
+served by the fortls, the built-in, both or none. By default
+`fortls` is used.
+
+```jsonc
+{
+  "fortran.provide.symbols": "fortls" | "Built-in" | "Both" | "Disable"
+}
+```
+
+You can also configure the case for fortran intrinsics auto-complete by using
 
-`findent` can also be used to generate dependency files for a project.
+```jsonc
+{
+    "fortran.preferredCase": "lowercase" | "uppercase"
+}
+```
 
 ## All options
 
@@ -204,8 +273,6 @@ A summary of all the options
 
 ## Requirements
 
-For the linter to work you need to have `gfortran` on your path, or wherever you configure it to be.
-
 For debugging you need to have one of the following debuggers installed:
 
 - **Linux**: GDB

SECURITY.md

@@ -2,20 +2,16 @@
 
 ## Supported Versions
 
-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+Only the latest version of the extension is actively supported. Out publisher
+ID in the VS Codes store changed with version `v3.0.0`, therefore older versions
+are no longer available for download.
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                |
+| >= 3.0  | :white_check_mark: |
+| < 3.0   | :x:                |
 
 ## Reporting a Vulnerability
 
-Use this section to tell people how to report a vulnerability.
-
-Tell them where to go, how often they can expect to get an update on a
-reported vulnerability, what to expect if the vulnerability is accepted or
-declined, etc.
+If a security vulnerability is found that is not already being tracked please open a
+[bug report](https://github.com/fortran-lang/vscode-fortran-support/issues/new?assignees=&labels=bug&template=bug_report.md&title=).

assets/README.md

@@ -0,0 +1,37 @@
+# Creating High Quality GIF animations
+
+Two scripts have been included inside the `tools` folder for ease of use, but the following instructions should allow for more custom-made GIFs
+
+## Steps
+
+1. Use a screen capturing software to record the animation
+2. Use `ffmpeg` to convert the animation into `.png` frames
+
+   > **Note:** this is also the step to add any additional editing to the original animation
+   > like padded boarders
+
+   ```sh
+        ffmpeg -i animation.mp4 frame%05d.png
+   ```
+
+   or adding additional options like a border
+
+   ```sh
+       ffmpeg -i animation.mp4 -vf "pad=width=900:height=550:x=5:y=5:color=734f96" frame%05d.png
+   ```
+
+3. Download [Gifski](https://gif.ski) to merge the frames into a `.gif` and run
+
+   > **Note:** gifski produces the most color-accurate GIFs
+
+   ```sh
+       gifski --width 888 -o output.gif frame*.png
+   ```
+
+Alternatively to step **3.** one can use `ffmpeg`, but the final animation will be
+considerably less sharp and artifact-free.
+
+```sh
+ffmpeg -i animation.mp4 -vf palettegen palette.png
+ffmpeg -i animation.mp4 -i palette.png -filter_complex "fps=15,scale=-1:-1:flags=lanczos[x];[x][1:v]paletteuse" output.gif
+```