Skip to content

Commit 1369150

Browse files
committed
Rework extension's README.md file as entry point for marketplaces
- Give only basic overview for users - Show screenshot of extension in action - Link to documentation + feature tour
1 parent 2a60502 commit 1369150

2 files changed

Lines changed: 8 additions & 31 deletions

File tree

vscode-extension/README.md

Lines changed: 8 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,19 @@
1-
# ilspy-vscode (Extension)
1+
# ILSpy Visual Studio Code Extension
22

3-
This is the actual VSCode extension part of the project, which fulfills following tasks:
3+
The ILSpy extension for VS Code is a cross-platform implementation of ILSpy .NET assembly browser and decompiler running inside of Visual Studio Code - in contrast to the [ILSpy desktop application](https://github.com/icsharpcode/ILSpy) running standalone on Windows systems.
44

5-
* Integrates ILSpy UI elements (like Assembly Tree, Search and Analyze panels, palette commands) into VSCode shell
6-
* Manages extension settings (global and workspace-specific)
7-
* Controls [backend](../backend/README.md) process launching it at startup and initializing it with configuration
8-
* Installs a required version of .NET runtime using Microsoft's [.NET Install Tool for Extension Authors](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.vscode-dotnet-runtime)
5+
![ILSpy VS Code Extension](https://raw.githubusercontent.com/icsharpcode/ilspy-vscode/tree/master/vscode-extension/docs/extension-view.png)
96

10-
A description of the extension's features can be found in [Feature Tour](https://github.com/icsharpcode/ilspy-vscode/wiki/Feature-Tour).
7+
## Getting Started
118

12-
## Export decompiled code
9+
* [Installation](https://github.com/icsharpcode/ilspy-vscode/wiki/Installation)
10+
* [Feature Tour](https://github.com/icsharpcode/ilspy-vscode/wiki/Feature-Tour)
1311

14-
To export all decompiled code of a loaded assembly, right-click the assembly node in the `ILSpy: Assemblies` view and run `Export Decompiled Code...`. This will generate a complete C# project including:
15-
- All decompiled source files organized by namespace
16-
- A .csproj project file for easy compilation
12+
See the [Feature Comparison List](https://github.com/icsharpcode/ilspy-vscode/wiki/Feature-Comparison) for the differences between ILSpy desktop application and the VS Code extension.
1713

1814
## Requirements
1915

20-
- Visual Studio Code >= 1.101
16+
- Visual Studio Code >= 1.110
2117
- .NET 10.0 (installed automatically on first start)
2218
- Node.js (22 or newer)
2319
- PNPM
24-
25-
## Development
26-
27-
To debug and run the extension, you first need to build and package the backend:
28-
29-
```
30-
cd ..
31-
buildtools/publish-backend
32-
```
33-
34-
The backend's binaries are automatically copied to `vscode-extension/bin/ilspy-backend`, where the extension expects them.
35-
36-
Then initialize the project with
37-
38-
```
39-
pnpm install
40-
```
41-
42-
Open this directory in Visual Studio Code and start debugging with <kbd>F5</kbd>. A development instance of VS Code will open with the latest extension code running.
184 KB
Loading

0 commit comments

Comments
 (0)