Skip to content

Commit 30986f1

Browse files
noppejnoppej
authored
Merge pull request #52 from probe-rs/readme_change
README files for GitHub and extension marketplace
2 parents 018fc4f + d514b09 commit 30986f1

File tree

4 files changed

+89
-90
lines changed

4 files changed

+89
-90
lines changed

‎.github/README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# VS Code probe-rs-debugger
2+
3+
## Documentation
4+
5+
Full documentation on [Installation](https://probe.rs/docs/tools/vscode/#installation), [Configuration](https://probe.rs/docs/tools/vscode/#usage-and-configuration) and [supported functionality](https://probe.rs/docs/tools/vscode/#current-working-functionality-and-known-limitations)
6+
can be found at [the probe-rs webpage](https://probe.rs/docs/tools/vscode/) and
7+
under the [visual tour
8+
heading](https://probe.rs/docs/tools/vscode/#a-visual-guide-of-implemented-features)
9+
10+
<img style="margin-top: 1em; margin-bottom: 1em; max-width:100%; max-height:100%; width: auto; height: auto;" src="https://probe.rs/img/vscode/probe-rs-debugger.gif" />
11+
12+
## Development Setup - only applies if you want to contribute to the extension
13+
14+
To work on this extensions, you first need to install VS Code and nodejs.
15+
Afterwards, follow the following steps:
16+
17+
* Checkout this repository
18+
* Inside the repository, install the prerequisites:
19+
20+
npm install
21+
22+
* Install the extensions VS Code recommends. If you prefer to do this manually,
23+
you can find the list of recommended extensions in the repository's
24+
`.vscode/settings.json' file. These can then be installed from the command
25+
line, for example:
26+
27+
code --install-extension amodio.tsl-problem-matcher
28+
29+
* Open VS Code
30+
* Press F5 to start a new VS Code instance where the extension can be debugged.
31+
You can also open the "Run and Debug" panel in the left sidebar, and then
32+
start the "Extension" debug configuration.
33+
34+
### To run against a compiled executable of `probe-rs-debugger`
35+
36+
* Press `F5` to __build and launch executable__ `probe-rs-debugger`. VSCode will
37+
open another VS Code window, titled __[Extension Development Host]__.
38+
* In this new VSCode window,
39+
* Open an existing project, or create a new one.
40+
* In your project, configure the `launch.json` in your project, as per [the minimum configuration](https://probe.rs/docs/tools/vscode/#start-a-debug-session-with-minimum-configuration) example.
41+
* Select the debug environment you just created.
42+
* Press `F5` to start debugging.
43+
44+
### To run against a debuggable instance of `probe-rs-debugger`
45+
46+
* Clone the [probe-rs](https://github.com/probe-rs/probe-rs.git) repository, and
47+
open it in VSCode.
48+
* In this `probe-rs` repo, select the debug environment `DAP-Server
49+
probe-rs-debugger`
50+
* Press `F5` to start `probe-rs-debugger` as a debuggable server.
51+
* Switch to the VSCode instance of the probe-rs `vscode` repository.
52+
* In this new VSCode window,
53+
* Open an existing project, or create a new one.
54+
* In your project, configure the `launch.json` in your project, as per [the existing debugger server](https://probe.rs/docs/tools/vscode/#using-to-an-existing-probe-rs-debugger-server) example.
55+
* Select the debug environment you just created.
56+
* Press `F5` to start debugging.
57+
58+
## Releasing the extension
59+
60+
The extension can only be released as part of the CI process on GitHub Actions.
61+
- The CI process will automatically build the extension and publish it to the
62+
[VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=probe-rs.probe-rs-debugger)
63+
when the project maintainers create a new release on GitHub.
64+
65+
### Build the extension
66+
67+
Building the extension refers to the process that generates the installable
68+
`.vsix` package.
69+
70+
* Follow the instructions to [setup your development
71+
environment](#development-setup).
72+
* In a terminal window, execute the following command:
73+
74+
npm run package
75+
76+
* This will generate a .vsix file in the root of the repository
77+
78+
## Contributing
79+
80+
Unless you explicitly state otherwise, any contribution intentionally submitted
81+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
82+
be dual licensed, without any additional terms or conditions, according to:
83+
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
84+
http://www.apache.org/licenses/LICENSE-2.0)
85+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
86+
http://opensource.org/licenses/MIT) at your option.

‎README.md‎

Lines changed: 2 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# VS Code probe-rs-debugger
22

3+
A VS Code extension for debugging embedded Rust applications using probe-rs, with support for a large range of debug probes and chips, including many variants of ARM Cortex-M, ARM Cortex-A, and RISC-V.
4+
35
## Documentation
46

57
Full documentation on [Installation](https://probe.rs/docs/tools/vscode/#installation), [Configuration](https://probe.rs/docs/tools/vscode/#usage-and-configuration) and [supported functionality](https://probe.rs/docs/tools/vscode/#current-working-functionality-and-known-limitations)
@@ -8,79 +10,3 @@ under the [visual tour
810
heading](https://probe.rs/docs/tools/vscode/#a-visual-guide-of-implemented-features)
911

1012
<img style="margin-top: 1em; margin-bottom: 1em; max-width:100%; max-height:100%; width: auto; height: auto;" src="https://probe.rs/img/vscode/probe-rs-debugger.gif" />
11-
12-
## Development Setup - only applies if you want to contribute to the extension
13-
14-
To work on this extensions, you first need to install VS Code and nodejs.
15-
Afterwards, follow the following steps:
16-
17-
* Checkout this repository
18-
* Inside the repository, install the prerequisites:
19-
20-
npm install
21-
22-
* Install the extensions VS Code recommends. If you prefer to do this manually,
23-
you can find the list of recommended extensions in the repository's
24-
`.vscode/settings.json' file. These can then be installed from the command
25-
line, for example:
26-
27-
code --install-extension amodio.tsl-problem-matcher
28-
29-
* Open VS Code
30-
* Press F5 to start a new VS Code instance where the extension can be debugged.
31-
You can also open the "Run and Debug" panel in the left sidebar, and then
32-
start the "Extension" debug configuration.
33-
34-
### To run against a compiled executable of `probe-rs-debugger`
35-
36-
* Press `F5` to __build and launch executable__ `probe-rs-debugger`. VSCode will
37-
open another VS Code window, titled __[Extension Development Host]__.
38-
* In this new VSCode window,
39-
* Open an existing project, or create a new one.
40-
* In your project, configure the `launch.json` in your project, as per [the minimum configuration](https://probe.rs/docs/tools/vscode/#start-a-debug-session-with-minimum-configuration) example.
41-
* Select the debug environment you just created.
42-
* Press `F5` to start debugging.
43-
44-
### To run against a debuggable instance of `probe-rs-debugger`
45-
46-
* Clone the [probe-rs](https://github.com/probe-rs/probe-rs.git) repository, and
47-
open it in VSCode.
48-
* In this `probe-rs` repo, select the debug environment `DAP-Server
49-
probe-rs-debugger`
50-
* Press `F5` to start `probe-rs-debugger` as a debuggable server.
51-
* Switch to the VSCode instance of the probe-rs `vscode` repository.
52-
* In this new VSCode window,
53-
* Open an existing project, or create a new one.
54-
* In your project, configure the `launch.json` in your project, as per [the existing debugger server](https://probe.rs/docs/tools/vscode/#using-to-an-existing-probe-rs-debugger-server) example.
55-
* Select the debug environment you just created.
56-
* Press `F5` to start debugging.
57-
58-
## Releasing the extension
59-
60-
The extension can only be released as part of the CI process on GitHub Actions.
61-
- The CI process will automatically build the extension and publish it to the
62-
[VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=probe-rs.probe-rs-debugger)
63-
when the project maintainers create a new release on GitHub.
64-
65-
### Build the extension
66-
67-
Building the extension refers to the process that generates the installable
68-
`.vsix` package.
69-
70-
* Follow the instructions to [setup your development
71-
environment](#development-setup).
72-
* In a terminal window, execute the following command:
73-
74-
npm run package
75-
76-
* This will generate a .vsix file in the root of the repository
77-
78-
## Contributing
79-
80-
Unless you explicitly state otherwise, any contribution intentionally submitted
81-
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
82-
be dual licensed, without any additional terms or conditions, according to:
83-
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
84-
http://www.apache.org/licenses/LICENSE-2.0)
85-
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
86-
http://opensource.org/licenses/MIT) at your option.

‎README_PUBLISH.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎package.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
{
22
"name": "probe-rs-debugger",
33
"displayName": "Debugger for probe-rs",
4-
"version": "0.17.1",
4+
"version": "0.17.2",
55
"publisher": "probe-rs",
66
"description": "probe-rs Debug Adapter for VS Code.",
77
"author": {
88
"name": "Jack Noppé",
99
"email": "[email protected]"
1010
},
11-
"readme": "README_publish.md",
1211
"license": "(MIT OR Apache-2.0)",
1312
"pricing": "Free",
1413
"keywords": [

0 commit comments

Comments
 (0)