diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..a46426b --- /dev/null +++ b/.github/README.md @@ -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) + + + +## 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. diff --git a/README.md b/README.md index a46426b..67bc3d2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # VS Code probe-rs-debugger +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. + ## 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) @@ -8,79 +10,3 @@ under the [visual tour heading](https://probe.rs/docs/tools/vscode/#a-visual-guide-of-implemented-features) - -## 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. diff --git a/README_PUBLISH.md b/README_PUBLISH.md deleted file mode 100644 index 67bc3d2..0000000 --- a/README_PUBLISH.md +++ /dev/null @@ -1,12 +0,0 @@ -# VS Code probe-rs-debugger - -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. - -## 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) - - diff --git a/package.json b/package.json index 04cce92..20c1f14 100644 --- a/package.json +++ b/package.json @@ -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": "noppej@hotmail.com" }, - "readme": "README_publish.md", "license": "(MIT OR Apache-2.0)", "pricing": "Free", "keywords": [