Merge pull request #2 from GaijinEntertainment/release-1.0.0

Version 1.0.0

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,43 @@
+name: Report a bug
+description: Report a bug, for example, the extension crashes, or one of the features doesn't work correctly, etc.
+title: '[Bug]: '
+labels: ['bug']
+assignees:
+    - zalan-racz-gaijin
+body:
+    - type: markdown
+      attributes:
+          value: __Please, don't share any information, that is not supposed to be public!__ While most of the fields are not required, please give me as much information as possible to be able to reproduce the problem.
+    - type: input
+      id: extension-version
+      attributes:
+          label: The extension's version
+          description: You can find it in the extensions's page in the __Extensions__ tab, next to the extension's name.
+          placeholder: eg. 1.3.6
+    - type: input
+      id: vs-code-version
+      attributes:
+          label: VS Code's version
+          description: You can find it in __Help__ / __About__.
+          placeholder: eg. 1.84.1
+    - type: dropdown
+      id: extension-host
+      attributes:
+          label: Extension host
+          description: Choose __Desktop VS Code__ if you downloaded VS Code, and choose __VS Code for the Web__, if you used <https://vscode.dev>, <https://github.dev>, or similar.
+          options:
+              - Desktop VS Code
+              - VS Code for the Web
+    - type: input
+      id: operating-system
+      attributes:
+          label: Operating system
+          description: Please provide the CPU architecture as well, like x64, or ARM64, etc.
+          placeholder: eg. Windows 11 x64
+    - type: textarea
+      id: description
+      attributes:
+          label: Description
+          description: Please provide information, like what have you done when the problem happened, what exactly happened, error messages, logs, pictures, etc.
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,16 @@
+name: Request a feature
+description: Request a completely new feature or the enhancement of an already existing feature.
+title: '[Feature]: '
+labels: ['enhancement']
+assignees:
+    - zalan-racz-gaijin
+body:
+    - type: markdown
+      attributes:
+          value: __Please, don't share any information, that is not supposed to be public!
+    - type: textarea
+      id: feature-details
+      attributes:
+          label: Feature details
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,14 @@
+name: Other
+description: If you have a question, a suggestion, or anything that is not a bug report and not a feature request.
+assignees:
+    - zalan-racz-gaijin
+body:
+    - type: markdown
+      attributes:
+          value: __Please, don't share any information, that is not supposed to be public!
+    - type: textarea
+      id: content
+      attributes:
+          label: Content
+      validations:
+          required: true

CHANGELOG.md

@@ -1,11 +1,11 @@
 # Change Log
 
-There are no public releases yet.
+## [1.0.0] - 2023.12.11.
 
-## [Unreleased]
+### Added
 
 -   Syntax highlight
--   Document links (ctrl + click on #include, include, and include_optional directives)
+-   Document links
 -   Comment toggling
 -   Bracket matching
 -   Auto closing pairs

README.md

@@ -2,12 +2,70 @@
 
 [![build](https://github.com/GaijinEntertainment/Dagor-Shader-Language-Support-for-Visual-Studio-Code/actions/workflows/build.yml/badge.svg)](https://github.com/GaijinEntertainment/Dagor-Shader-Language-Support-for-Visual-Studio-Code/actions/workflows/build.yml)
 
-Dagor Shader Language Support for Visual Studio Code. At the moment it's work in progress. In order to use the extension, you have to install Node.js if you're not on x64 architecture.
+Dagor Shader Language Support for Visual Studio Code. If you're not on x64 architecture, you have to install Node.js in order to use the extension.
 
 ## Features
 
+### Syntax highlight
+
+![syntax highlight, dark theme](res/screenshots/syntax-highlight-dark.png)
+
+![syntax highlight, light theme](res/screenshots/syntax-highlight-light.png)
+
+### Document links
+
+This feature only works in the desktop version.
+
+![document links](res/screenshots/document-link.gif)
+
+### Comment toggling
+
+![comment toggling](res/screenshots/comment-toggle.gif)
+
+### Bracket matching
+
+![bracket matching](res/screenshots/bracket-match.gif)
+
+### Auto closing pairs
+
+![auto closing pairs](res/screenshots/auto-close.gif)
+
+### Surrounding pairs
+
+![surrounding pairs](res/screenshots/surround.gif)
+
+### Folding regions
+
+![folding regions](res/screenshots/folding-region.gif)
+
+### Indentation
+
+![indentation](res/screenshots/indentation.gif)
+
+### Code snippets
+
+![code snippets](res/screenshots/snippets.gif)
+
+### File icons
+
+![file icons](res/screenshots/icons.png)
+
+## Configuration
+
+-   `dagorShaderLanguageServer.shaderConfigOverride`: Shader configs are .blk files, usually located in the games' `prog/shaders` folders, and they determine include folders. For example: `samples/testGI/prog/shaders/shaders_dx12.blk`. If you want to override the extension's automatic shader config selection, provide the shader config's path here. Leaving it empty enables the automatic selection based on game, platform, and driver in launch options.
+
+## Issues
+
+If you have any problems or feature request for the extension, feel free to create an issue.
+
+## Release Notes
+
+For more information, see the [changelog](CHANGELOG.md).
+
+### 1.0.0
+
 -   Syntax highlight
--   Document links (ctrl + click on #include, include, and include_optional directives)
+-   Document links
 -   Comment toggling
 -   Bracket matching
 -   Auto closing pairs
@@ -16,11 +74,3 @@ Dagor Shader Language Support for Visual Studio Code. At the moment it's work in
 -   Indentation
 -   Code snippets
 -   File icons
-
-## Issues
-
-If you have any problems or feature request for the extension, feel free to create an issue.
-
-## Build
-
-If you need more informations about the extension's source code, there are [detailed instructions about how to build, run, test, debug, and package](https://github.com/GaijinEntertainment/Dagor-Shader-Language-Support-for-Visual-Studio-Code/blob/main/BUILD.md) it.