Skip to content

Commit

Permalink
cleanup README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
sarvalabs-manish committed Jul 20, 2023
1 parent 4475040 commit 88a3a30
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 48 deletions.
12 changes: 3 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
# Change Log

All notable changes to the "coco" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]

- Initial release
## v0.1.0
- Initial release of the **Coco Extension for Visual Studio Code**
- Adds support for **Cocolang v0.1.0 (alpha)** with simple syntax highlighting
66 changes: 27 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,49 @@
# Coco for Visual Studio Code

![license](https://img.shields.io/badge/license-MIT-informational?style=for-the-badge)
![latest tag](https://img.shields.io/github/v/tag/sarvalabs/vscode-coco?color=blue&label=latest%20tag&sort=semver&style=for-the-badge)
![issue count](https://img.shields.io/github/issues/sarvalabs/vscode-coco?style=for-the-badge&color=yellow)

## Features
The VS Code Coco extension provides syntax highlighting for the [Coco programming language](http://cocolang.dev).

Introducing vscode-coco, a powerful extension that elevates your coding experience with precise syntax highlighting for Coco. Enjoy customizable color themes, nested scope support, and seamless integration with other extensions. Boost productivity with smooth performance and comprehensive coverage of Coco code variants. Simplify your coding workflow and focus on what matters most – writing clean and efficient code.
**NOTE**: Currently, it must be manually installed using a `.vsix` file. We are actively working to publish this
extension on the Visual Studio Code Marketplace.

## Requirements

- [Visual Studio Code](https://code.visualstudio.com/download) - The code editor where you will use the extension.
### Requirements
- [Visual Studio Code](https://code.visualstudio.com/download) (v0.1.59 or greater)

### Installation
Install the extension manually with the `.vsix` file available in the releases.

To install the Coco VSIX extension, follow these steps:

1. Download the latest release of the Coco VSIX extension from the [GitHub repository](https://github.com/sarvalabs/vscode-coco).

1. Download the latest release of the Coco extension from the [releases](https://github.com/sarvalabs/vscode-coco/releases)
2. Open Visual Studio Code.

3. In Visual Studio Code, go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side of the window or using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac).

3. In Visual Studio Code, go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side
of the window or using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac).
4. Click on the three dots menu icon (⋮) in the Extensions View's top-right corner, and select "Install from VSIX."

5. Browse to the location where you downloaded the Coco VSIX extension `.vsix` file, select it, and click "Open."

6. The Coco VSIX extension will now be installed in Visual Studio Code.
6. The Coco extension will now be installed in Visual Studio Code.

### Using the Extension

To use the Coco VSIX extension, follow these steps:
To use the Coco extension, follow these steps:

1. Open a project or file in Visual Studio Code that is relevant to the functionality provided by the extension.

2. The Coco VSIX extension should automatically start working if it has any features that apply to the current project or file. Otherwise, you may need to trigger the extension manually by interacting with its commands, settings, or other integration points.

3. Refer to the extension's documentation or the README file of the Coco VSIX extension's GitHub repository to learn about its specific features and how to use them effectively.
2. The Coco extension should automatically start working if it has any features that apply to the current project
or file. Otherwise, you may need to trigger the extension manually by interacting with its commands, settings, or
other integration points.
3. Refer to the extension's documentation or the README file of the Coco extension's GitHub repository to learn
about its specific features and how to use them effectively.

### Uninstalling the Extension

If you want to uninstall the Coco VSIX extension, follow these steps:
If you want to uninstall the Coco extension, follow these steps:

1. Open Visual Studio Code.

2. Go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side of the window or using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac).

3. Find the installed Coco VSIX extension in the Extensions View.

4. Click on the gear icon next to the Coco VSIX extension's name and select "Uninstall."

2. Go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side of the window or
using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac).
3. Find the installed Coco extension in the Extensions View.
4. Click on the gear icon next to the Coco extension's name and select "Uninstall."
5. Confirm the uninstallation when prompted.

### Feedback and Issues

If you encounter any issues with the Coco VSIX extension or have suggestions for improvements, please check the [extension's GitHub repository](https://github.com/sarvalabs/vscode-coco) for issue tracking. You can open a new issue to report problems or submit feature requests.

## For more information

* [COCOlang Website](http://cocolang.dev)
* [MOI Protocol](https://moi.technology)

**Enjoy!**
If you encounter any issues with the Coco extension or have suggestions for improvements, please check
the extension's [GitHub repository](https://github.com/sarvalabs/vscode-coco) for issue tracking.
You can open a new issue to report problems or submit feature requests.

0 comments on commit 88a3a30

Please sign in to comment.