Skip to content

Commit

Permalink
Add a separate README for the market place
Browse files Browse the repository at this point in the history
Add a separate, more concise README that's displayed in the Visual
Studio market place. Change the "npm run package" command to pick up
this README.

Change-Id: I796436b54a8a0b700fb632ce6ff22bd76bc3f5fb
Reviewed-by: Marcus Tillmanns <[email protected]>
Reviewed-by: Orkun Tokdemir <[email protected]>
Reviewed-by: Kai Köhne <[email protected]>
  • Loading branch information
jobor committed Jul 15, 2024
1 parent 0d3d7fc commit 5d57c94
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions README-marketplace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Qt Extension for Visual Studio Code

Develop Qt applications with Visual Studio Code.

## Features
- QML syntax highlighting and code completion
- Build Qt projects with CMake
- Debug Qt's C++ types
- Design Qt widgets-based UIs with Qt Widgets Designer
- Access Qt's documentation

## Prerequisites

The [CMake](https://github.com/twxs/vs.language.cmake) and [CMake
Tools](https://github.com/microsoft/vscode-cmake-tools) extensions are
required. They will be installed automatically.

## Quick Start

1. Install the extension.
1. Register Qt installation: The extension prompts you to register the
Qt versions it detects.
1. Open a Qt project and start developing!

Check detailed guideline for using the extension
[here](https://github.com/qt-labs/vscodeext#get-started).

## Issues

If you encounter any issues with the extension, kindly [report the
issues](https://bugreports.qt.io/projects/VSCODEEXT).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@
"checkPackage": "ts-node ./src/scripts/check_package.ts",
"generateLicenses": "ts-node ./src/scripts/generate_licenses.ts",
"prettier": "prettier --write \"**/*.{js,ts,json,mjs,cjs}\" --log-level silent",
"package": "npm ci && vsce package --out out"
"package": "npm ci && vsce package --readme-path README-marketplace.md --out out"
},
"devDependencies": {
"@types/chai": "^4.3.10",
Expand Down

0 comments on commit 5d57c94

Please sign in to comment.