Skip to content

Commit

Permalink
docs: tweak setup docs (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
neilcampbell authored Dec 15, 2023
1 parent 183a8a5 commit 582d851
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 25 deletions.
4 changes: 4 additions & 0 deletions .releaserc.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
{
"type": "chore",
"release": "patch"
},
{
"type": "docs",
"release": "patch"
}
]
}
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
1. A new "Extension Development Host" VS Code instance will be launched. If launching the multi-root workspace, then reload this VS Code instance as a workspace.
1. Initiate an AVM debug session using the configurations in the "Run and Debug" pane inside the "Extension Development Host" VS Code instance.

### Create and Install a Test Extension Package

1. Run `npm run build`.
1. Run `npm run package` to produce a `.vsix` package in the project root.
1. Open a repository containing artefacts you'd like to debug in VS Code and install the `.vsix` package.
1. Follow the steps in the [Readme Usage section](./README.md#usage) section.

### Debug the AVM Debug Adapter and Debugger

1. Uncomment `"avmDebugger.debugAdapter.port": 4711` in `settings.json` and `sample.code-workspace` located in the example workspaces in this repository.
Expand All @@ -23,3 +30,7 @@
1. Open the `avm-debugger` repository root in VS Code.
1. Run the "Server" configuration via the "Run and Debug" pane, which starts the debug adapter on port 4711.
1. Run the steps in [Run/Debug the AVM Debugger Extension](#rundebug-the-avm-debugger-extension).

## Commits

We are using the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) standard for commit messages. This allows us to automatically generate release notes and version numbers. We do this via [Semantic Release](https://semantic-release.gitbook.io/semantic-release/) and [GitHub actions](.github/workflows/cd.yaml).
29 changes: 4 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,34 +50,9 @@ Before you can use the AVM Debugger extension, you need to ensure that you have
## Installation

### Via VS Code Marketplace

1. Install the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=algorandfoundation.algokit-avm-vscode-debugger).
2. Follow the next steps in the [Usage](#usage) section.

### For Development

To install the extension for development, follow these steps:

1. Clone the repository:
```
git clone https://github.com/MakerXStudio/algokit-vscode-debugger.git
```
2. Navigate into the cloned repository:
```
cd algokit-vscode-debugger
```
3. Install the dependencies:
```
npm install
```
4. Build the extension:
```
npm run build
```
5. Open the repository in VS Code and install the `.vsix` artifact.
6. Follow the next steps in the [Usage](#usage) section.

## Usage

In order to use the AVM Debugger extension, you need:
Expand Down Expand Up @@ -190,6 +165,10 @@ This document outlines the features supported by the AVM debugger. Screenshots a
| Watch values | Specific values can be added to the watch list. Negative indexing is supported to look up values relative to the top of the stack. | ![Watched values](images/watch%20values.png) |
| Inspect application state | The debugger allows inspection and watching of any available application state from the execution. | ![Inspecting application state variables](images/app%20state%20variables%20expanded.png) |

## How can I contribute?

This is an open source project managed by the Algorand Foundation. See the [contributing page](./CONTRIBUTING.md) to learn about making improvements, including developer setup instructions.

## Contact

If you have any issues or feature requests, please [open an issue](https://github.com/algorandfoundation/algokit-avm-vscode-debugger/issues/new).

0 comments on commit 582d851

Please sign in to comment.