hello-fuzzy README
Features
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
For example if there is an image subfolder under your extension project workspace:
Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
Requirements
This VSCode plugin relies on the following external programs:
GNU Global (global): A source code tagging system for code navigation.
GNU Global Tags (gtags): The tag generation tool for GNU Global.
Exuberant Ctags (ctags): A tool for generating code tags, supporting multiple programming languages.
Below are the installation instructions for both Windows and macOS systems.
Windows Installation
Install Chocolatey (Package Manager)
If you don't have Chocolatey installed, follow these steps to install it:
Open PowerShell as Administrator.
Run the following command to install Chocolatey:
Set-ExecutionPolicy Bypass -Scope Process -Force;
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072;
iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
Install Dependencies
Open PowerShell as Administrator.
Use Chocolatey to install global and ctags:
choco install global ctags
Verify Installation
Open Command Prompt or PowerShell.
Run the following commands to verify the installation:
global --version
gtags --version
ctags --version
If the version information is displayed, the installation is successful.
macOS Installation
Install Homebrew (Package Manager)
If you don't have Homebrew installed, follow these steps to install it:
Open Terminal.
Run the following command to install Homebrew:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Install Dependencies
Open Terminal.
Use Homebrew to install global and ctags:
brew install global ctags
Verify Installation
Open Terminal.
Run the following commands to verify the installation:
global --version
gtags --version
ctags --version
If the version information is displayed, the installation is successful.
Open VSCode and Install your plugin.
In the plugin's configuration file, ensure the paths to global, gtags, and ctags executables are correctly set.
Save the configuration and restart VSCode.
References
GNU Global Official Documentation
Exuberant Ctags Official Documentation
Chocolatey Official Documentation
Homebrew Official Documentation
Extension Settings
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.myExtension.thing: Set to blah to do something.
Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
Release Notes
Users appreciate release notes as you update your extension.
1.0.0
Initial release of ...
1.0.1
Fixed issue #.
1.1.0
Added features X, Y, and Z.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
- Toggle preview (
Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
- Press
Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!
