Skip to content

Commit cec93d4

Browse files
committed
docs: enhance README with detailed settings options and project structure
1 parent 9956be4 commit cec93d4

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

README.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ This project provides a command palette extension for opening Visual Studio Code
2424
</a>
2525

2626
### Via Command Palette
27+
2728
1. Open Command Palette
2829
2. Select "Command Palette - VS Code"
2930

3031
### Via Winget
32+
3133
1. Open Command Prompt or PowerShell
3234
2. Run the following command:
3335
```bash
@@ -42,15 +44,39 @@ This project provides a command palette extension for opening Visual Studio Code
4244
## Settings
4345

4446
- **Preferred Edition**: Determines which edition (Default or Insider) is used when a folder or workspace has been opened in both editions of VS Code.
45-
- **Use Strict Search**: Enables or disables strict search for workspaces.
47+
- Options:
48+
- **Default**: Uses the standard VS Code edition
49+
- **Insider**: Uses the VS Code Insider edition
50+
- **Use Strict Search**: Enables or disables strict search for workspaces.
4651
- **Strict Search**: Matches items where the search text appears as a contiguous substring in the item's title or subtitle. For example, searching for "abc" will match "abc" or "abc123" but not "a1b2c3".
4752
- **Show Details Panel**: Toggles the visibility of the details panel in the UI.
48-
- **Tag Type**: Configures the tags displayed for each workspace.
49-
- Options:
50-
- **None**: No tags are displayed.
51-
- **Type**: Displays the workspace type (e.g., Local, WSL, Remote).
52-
- **Target**: Displays the target instance name (e.g., VS Code, VS Code Insider).
53+
- **Tags**: Configures the tags displayed for each workspace.
54+
- Options:
55+
- **None** (-): No tags are displayed.
56+
- **Type**: Displays the workspace type (e.g., Local, WSL, Remote).
57+
- **Target**: Displays the target instance name (e.g., VS Code, VS Code Insider).
5358
- **Type & Target**: Displays both the workspace type and the target instance name.
59+
- **Command Result Action**: Determines what should happen after opening a VS Code workspace.
60+
- Options:
61+
- **Dismiss**: Closes the Command Palette after opening the workspace
62+
- **Go Back**: Returns to the previous Command Palette view
63+
- **Keep Open**: Keeps the Command Palette open after opening the workspace
64+
65+
## Technical Information
66+
67+
- **Version**: 1.6.0.0
68+
- **Target Framework**: .NET 9.0 (Windows 10.0.22621.0)
69+
- **Minimum OS Version**: Windows 10 (10.0.19041.0)
70+
- **Architecture Support**: x64, ARM64
71+
- **Package Type**: MSIX (Microsoft Store app)
72+
73+
## Project Structure
74+
75+
- **Main Application**: [`CmdPalVsCode.cs`](VsCode/CmdPalVsCode.cs) - Main extension implementation
76+
- **Commands Provider**: [`CmdPalVsCodeCommandsProvider.cs`](VsCode/CmdPalVsCodeCommandsProvider.cs) - Command palette provider
77+
- **Settings Management**: [`SettingsManager.cs`](VsCode/Classes/SettingsManager.cs) - Handles user preferences
78+
- **VS Code Integration**: [`OpenVsCodeCommand.cs`](VsCode/Commands/OpenVsCodeCommand.cs) - Command execution logic
79+
- **UI Pages**: [`VSCodePage.cs`](VsCode/Pages/VSCodePage.cs) - Main interface page
5480

5581
## Contributing
5682

0 commit comments

Comments
 (0)