Skip to content

feat: Update English README based on Chinese version #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaoconggit merged 2 commits into from
Nov 28, 2025
Merged

feat: Update English README based on Chinese version #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19969a8
Initial plan
Copilot Nov 28, 2025
c0c4af0
feat: Update English README based on Chinese version
Copilot Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README_EN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

# SharpPad

A lightweight tool for quickly validating C# code snippets, built with Roslyn and monaco-editor. Similar to LinqPad, with AI chat and AI completion support.
A lightweight tool for quickly validating C# code snippets, built with Roslyn and monaco-editor. Similar to LinqPad, with AI chat, AI completion, and AI edit support.

<img width="1917" height="1036" alt="image" src="https://github.com/user-attachments/assets/1a807014-844b-4ff0-b2dd-a81305101b3f" />
<img width="1917" height="1036" alt="image" src="https://github.com/user-attachments/assets/69cf6124-e3e1-4753-98da-0ee9cce80e5d" />


## PC Version Recommended
Expand All @@ -17,7 +17,7 @@ A lightweight tool for quickly validating C# code snippets, built with Roslyn an
4. Enjoy!

## Demo Site
- https://try.dotnet10.com
- https://try.dotnet10.com (Old version)

### Pre-0.2.0 Quick Start (Legacy)
1. Download the release package
Expand All @@ -40,13 +40,14 @@ https://github.com/gaoconggit/SharpPad/tree/main/KingOfTool
3. Right-click in the directory and select import KingOfTool.json

## Development Guide
#### Development Environment: Recommended VS 2022 + .NET 9.0
#### Development Environment: Recommended VS 2026 + .NET 10 SDK
1. Git clone the repository
2. Launch the SharpPad project in Visual Studio
3. Use `Ctrl + Enter` to run "Hello World"

## Keyboard Shortcuts

### Windows
- `Ctrl + Enter` - Run code
- `Alt + C` - Clear output
- `Ctrl + J` - Code suggestions
Expand All @@ -57,6 +58,16 @@ https://github.com/gaoconggit/SharpPad/tree/main/KingOfTool
- `Ctrl + Shift + K` - AI code editing
- `Ctrl + D` - Duplicate line

### macOS
- `Cmd + Enter` - Run code
- `Ctrl + Option + C` - Clear output
- `Cmd + J` - Code suggestions
- `Cmd + K` `Cmd + D` - Format code
- `Cmd + S` - Save code
- `Cmd + Shift + Space` - Manually trigger GPT auto-completion
- `Cmd + Shift + K` - AI code editing
- `Cmd + D` - Duplicate line

## Features

- Intelligent code suggestions
Expand All @@ -71,16 +82,17 @@ https://github.com/gaoconggit/SharpPad/tree/main/KingOfTool
- C# version selection support
- Mobile-friendly UI
- Visual Studio breakpoint debugging integration (see [Debugger.md](https://github.com/gaoconggit/SharpPad/blob/main/KingOfTool/Debugger.md))
- Windows and macOS PC clients
- Windows and macOS PC clients (macOS Silicon / Windows)
- NuGet package management page
- Multi-file support
- WinForms application execution support
- Web API execution support
- Avalonia execution support

## Planned Features

- Work in Progress
- Native breakpoint debugging
- File import/export on macOS

## Project Acknowledgment

Expand Down
Loading