Eminds VS Code Extension

Overview

The Eminds VS Code Extension provides an easy way to generate project documentation by sending project details to a backend API.

Features

• Select a project folder within VS Code.
• Enter project metadata (name, author, version).
• Send the project details to an API for documentation generation.
• Receive a confirmation message when documentation is successfully generated.

Installation

1. Install the required dependencies:

   npm install -g @vscode/vsce
   npm install
   

2. Build and package the extension:

   vsce package
   

3. Install the extension in VS Code:

   code --install-extension eminds-<version>.vsix
   

Usage

1. Open VS Code.
2. Run the command Eminds: Generate Documentation from the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
3. Select the project folder.
4. Provide the required details (Project Name, Author, and Version).
5. The extension sends the details to the backend.
6. If successful, a confirmation message is displayed.

Requirements

• Node.js & npm installed.
• VS Code installed.
• The backend API processes the project details and generates documentation.

Development

• Clone the repository.
• Install dependencies using npm install.
• Open the project in VS Code.
• Run the extension in the Extension Development Host using F5.

Contributing

Feel free to fork this repository and submit pull requests.

License

This project is licensed under the MIT License.