-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from probe-rs/readme_change
README files for GitHub and extension marketplace
- Loading branch information
Showing
4 changed files
with
89 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # VS Code probe-rs-debugger | ||
|
|
||
| ## Documentation | ||
|
|
||
| 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) | ||
| can be found at [the probe-rs webpage](https://probe.rs/docs/tools/vscode/) and | ||
| under the [visual tour | ||
| heading](https://probe.rs/docs/tools/vscode/#a-visual-guide-of-implemented-features) | ||
|
|
||
| <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" /> | ||
|
|
||
| ## Development Setup - only applies if you want to contribute to the extension | ||
|
|
||
| To work on this extensions, you first need to install VS Code and nodejs. | ||
| Afterwards, follow the following steps: | ||
|
|
||
| * Checkout this repository | ||
| * Inside the repository, install the prerequisites: | ||
|
|
||
| npm install | ||
|
|
||
| * Install the extensions VS Code recommends. If you prefer to do this manually, | ||
| you can find the list of recommended extensions in the repository's | ||
| `.vscode/settings.json' file. These can then be installed from the command | ||
| line, for example: | ||
|
|
||
| code --install-extension amodio.tsl-problem-matcher | ||
|
|
||
| * Open VS Code | ||
| * Press F5 to start a new VS Code instance where the extension can be debugged. | ||
| You can also open the "Run and Debug" panel in the left sidebar, and then | ||
| start the "Extension" debug configuration. | ||
|
|
||
| ### To run against a compiled executable of `probe-rs-debugger` | ||
|
|
||
| * Press `F5` to __build and launch executable__ `probe-rs-debugger`. VSCode will | ||
| open another VS Code window, titled __[Extension Development Host]__. | ||
| * In this new VSCode window, | ||
| * Open an existing project, or create a new one. | ||
| * 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. | ||
| * Select the debug environment you just created. | ||
| * Press `F5` to start debugging. | ||
|
|
||
| ### To run against a debuggable instance of `probe-rs-debugger` | ||
|
|
||
| * Clone the [probe-rs](https://github.com/probe-rs/probe-rs.git) repository, and | ||
| open it in VSCode. | ||
| * In this `probe-rs` repo, select the debug environment `DAP-Server | ||
| probe-rs-debugger` | ||
| * Press `F5` to start `probe-rs-debugger` as a debuggable server. | ||
| * Switch to the VSCode instance of the probe-rs `vscode` repository. | ||
| * In this new VSCode window, | ||
| * Open an existing project, or create a new one. | ||
| * 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. | ||
| * Select the debug environment you just created. | ||
| * Press `F5` to start debugging. | ||
|
|
||
| ## Releasing the extension | ||
|
|
||
| The extension can only be released as part of the CI process on GitHub Actions. | ||
| - The CI process will automatically build the extension and publish it to the | ||
| [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=probe-rs.probe-rs-debugger) | ||
| when the project maintainers create a new release on GitHub. | ||
|
|
||
| ### Build the extension | ||
|
|
||
| Building the extension refers to the process that generates the installable | ||
| `.vsix` package. | ||
|
|
||
| * Follow the instructions to [setup your development | ||
| environment](#development-setup). | ||
| * In a terminal window, execute the following command: | ||
|
|
||
| npm run package | ||
|
|
||
| * This will generate a .vsix file in the root of the repository | ||
|
|
||
| ## Contributing | ||
|
|
||
| Unless you explicitly state otherwise, any contribution intentionally submitted | ||
| for inclusion in the work by you, as defined in the Apache-2.0 license, shall | ||
| be dual licensed, without any additional terms or conditions, according to: | ||
| * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or | ||
| http://www.apache.org/licenses/LICENSE-2.0) | ||
| * MIT license ([LICENSE-MIT](LICENSE-MIT) or | ||
| http://opensource.org/licenses/MIT) at your option. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,13 @@ | ||
| { | ||
| "name": "probe-rs-debugger", | ||
| "displayName": "Debugger for probe-rs", | ||
| "version": "0.17.1", | ||
| "version": "0.17.2", | ||
| "publisher": "probe-rs", | ||
| "description": "probe-rs Debug Adapter for VS Code.", | ||
| "author": { | ||
| "name": "Jack Noppé", | ||
| "email": "[email protected]" | ||
| }, | ||
| "readme": "README_publish.md", | ||
| "license": "(MIT OR Apache-2.0)", | ||
| "pricing": "Free", | ||
| "keywords": [ | ||
|
|
||