Skip to content

Commit a287e2e

Browse files
Update readme for marketplace
1 parent 75d2012 commit a287e2e

File tree

2 files changed

+45
-27
lines changed

2 files changed

+45
-27
lines changed

README-dev.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# cquery
2+
3+
This is the Visual Studio Code extension for cquery. The main cquery language
4+
server which powers this extension is found at
5+
[https://github.com/cquery-project/cquery](https://github.com/cquery-project/cquery).
6+
7+
# Building
8+
9+
## Dependencies
10+
11+
Make sure you have `npm` installed.
12+
13+
## Build
14+
15+
```bash
16+
npm install
17+
python build.py
18+
```
19+
20+
Now, you can use vscode to install `out/cquery.vsix`.
21+
22+
# Deploying
23+
24+
To deploy a new release to the marketplace, simply run `publish.py` with a
25+
clean working directory. By default a patch release is performed.
26+
27+
```bash
28+
python publish.py [patch|minor|major]
29+
```
30+
31+
# LICENSE
32+
33+
MIT

README.md

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,17 @@
11
# cquery
22

3-
This is the Visual Studio Code extension for cquery. The main cquery language
4-
server which powers this extension is found at
5-
[https://github.com/cquery-project/cquery](https://github.com/cquery-project/cquery).
6-
7-
# Building
8-
9-
## Dependencies
10-
11-
Make sure you have `npm` installed.
12-
13-
## Build
14-
15-
```bash
16-
npm install
17-
python build.py
18-
```
19-
20-
Now, you can use vscode to install `out/cquery.vsix`.
21-
22-
# Deploying
23-
24-
To deploy a new release to the marketplace, simply run `publish.py` with a
25-
clean working directory. By default a patch release is performed.
26-
27-
```bash
28-
python publish.py [patch|minor|major]
29-
```
3+
[cquery](https://github.com/cquery-project/cquery) provides extremely fast,
4+
robust, and reliable C++ integration into vscode with a ton of features, like
5+
code lens, references, code completion, semantic highlighting, and much more.
6+
7+
You currently need to install and build the main cquery server (eventually this
8+
will be downloaded for you from prebuilts). See the [Getting
9+
Started](https://github.com/cquery-project/cquery/wiki/Getting-started) wiki
10+
entry.
11+
12+
This extension is still in preview. Please see additional documentation at the
13+
main cquery
14+
[wiki](https://github.com/cquery-project/cquery/wiki/Visual-Studio-Code).
3015

3116
# LICENSE
3217

0 commit comments

Comments
 (0)