Skip to content

Commit

Permalink
Modernize readme a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-wiemer committed Nov 8, 2024
1 parent 5329c1e commit b8a860e
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Download from a trusted source: [Visual Studio Marketplace](https://marketplace.

## AHK v2 full support is here! 🥂

AHK++ 6 now incorporates [AutoHotkey v2 Language Support by thqby](https://marketplace.visualstudio.com/items?itemName=thqby.vscode-autohotkey2-lsp), providing full AHK v2 support, including:
AHK++ 6 incorporates [AutoHotkey v2 Language Support by thqby](https://marketplace.visualstudio.com/items?itemName=thqby.vscode-autohotkey2-lsp), providing full support for AHK v2, including:

- Running, debugging, and stopping v1 and v2 scripts without changing settings
- Full syntax highlighting for v2 scripts
Expand All @@ -34,10 +34,6 @@ As always, please [🐛 report any issues](https://github.com/mark-wiemer-org/ah

💚 Special thanks again to [thqby](https://github.com/thqby), as this would not have been possible without thqby's open-source [AutoHotkey v2 Language Support](https://marketplace.visualstudio.com/items?itemName=thqby.vscode-autohotkey2-lsp)!

### ⛓️‍💥 Breaking changes

When adding all the new settings, VS Code's setting UX became overwhelming. Settings are now organized into flat objects, which should improve UX and reduce the need for breaking changes in the future! See [the changelog](./changelog.md) for details.

---

## Commands
Expand Down Expand Up @@ -72,15 +68,7 @@ With AHK++, you can compile, debug, and run your scripts with keyboard shortcuts

This extension provides basic debugging functions. If you need more debugging functions (such as conditional breakpoints), you can add an additional extension: [Install vscode-autohotkey-debug](https://marketplace.visualstudio.com/items?itemName=zero-plusplus.vscode-autohotkey-debug).

## Language Features

### IntelliSense

Supports IntelliSense for variables and functions.

### Function symbol

1. You can add a comment to the function using a semicolon on the line above the function declaration
## Language features

### Go to definition

Expand Down Expand Up @@ -129,7 +117,7 @@ Supports standard VS Code formatting with a few options.

![Code Format](image/codeFormat.jpg)

#### Formatter Directives
#### Formatter directives

Formatter directives instruct the formatter to behave a certain way on sections of code.

Expand All @@ -155,19 +143,19 @@ Formatter directives instruct the formatter to behave a certain way on sections
;@AHK++AlignAssignmentOff
```
## Credits
## Acknowledgements
This extension relies heavily on open-source code. A huge thank you to all these open-source participants who made the extension what it is today!
This extension relies heavily on open-source code. A huge thank you to all these open-source contributors who made the extension what it is today!
- [AutoHotkey Plus by cweijan](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-autohotkey-plus): AHK++ is a fork of AutoHotkey Plus by cweijan (Weijan Chen)
- [Contributions to AHK++ by kyklish](https://github.com/mark-wiemer-org/ahkpp/commits/main?author=kyklish): Greatly improved formatting and snippets by both fixing bugs and adding features
- [AutoHotkey v2 Language Support extension by thqby](https://marketplace.visualstudio.com/items?itemName=thqby.vscode-autohotkey2-lsp): The source of the v2 grammar and other great contributions
- [Contributions to AHK++ by kyklish](https://github.com/mark-wiemer-org/ahkpp/commits/main?author=kyklish): Greatly improved formatting and snippets by both fixing bugs and adding features
- [AutoHotkey v2 definition files by GroggyOtter](https://github.com/GroggyOtter/ahkv2_definition_rewrite)
- [AHK version selection by Lexikos](https://github.com/Lexikos/vscode-auto-select): The core code for automatically switching AHK versions
- [AutoHotkey by stef-levesque](https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-autohotkey): AutoHotkey Plus is a fork of stef-levesque's original AutoHotkey extension, which provided the original grammar and snippets for AHK
- People like you: Thank you for opening issues, offering suggestions, and providing information to the AHK community :)
## Links
- [GitHub](https://github.com/mark-wiemer-org/ahkpp): View code, file bugs, and join discussions
- [Reviews](https://marketplace.visualstudio.com/items?itemName=mark-wiemer.vscode-autohotkey-plus-plus&ssr=false#review-details): Help others discover AHK++ by leaving a review
- [GitHub repo](https://github.com/mark-wiemer-org/ahkpp): View code, file bugs, and join discussions
- [Reviews on VS Marketplace](https://marketplace.visualstudio.com/items?itemName=mark-wiemer.vscode-autohotkey-plus-plus&ssr=false#review-details): Help others discover AHK++ by leaving a review

0 comments on commit b8a860e

Please sign in to comment.