Skip to content

Commit

Permalink
Update readme, changelog and urls in package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
ThadHouse committed Jul 21, 2018
1 parent 42bee53 commit da1f6a8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 53 deletions.
17 changes: 13 additions & 4 deletions vscode-wpilib/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# Change Log
All notable changes to the "vscode-wpilib-core" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
All notable changes to the "vscode-wpilib" extension will be documented in this file.

## [Unreleased]
- Initial release

## [2019.0.0-alpha-3]
- Update to GradleRIO alpha 3 release
- Fix display name in vscode package
- Added changelog and updated readme

## [2019.0.0-alpha-2]
- Fix RioLog starting on cancelled task
- Fix displayed name on cancelling task command
- Remove workaround for upstream VS Code C++ extension
- Allow debug selection for roboRIO during alpha
- Store team number in WPILib json file rather then VS Code settings
54 changes: 5 additions & 49 deletions vscode-wpilib/README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,19 @@
# vscode-wpilib-core README
# WPILib VSCode 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:

\!\[feature X\]\(images/feature-x.png\)

> 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.
This extension provides the WPILib support for FRC teams in VS Code.

## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
The extension has no required dependencies, however to get the most out of the extension, you will want the `Java Extension Pack` and the `C/C++` extension from the extension marketplace.

## 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
TODO

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.
This is an alpha, so if you find any PLEASE report them.

## 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.

-----------------------------------------------------------------------------------------------------------

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) to see a list of Markdown snippets

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**
1 change: 1 addition & 0 deletions vscode-wpilib/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@
}
},
"repository": "https://github.com/wpilibsuite/vscode-wpilib",
"homepage": "https://github.com/wpilibsuite/vscode-wpilib",
"scripts": {
"vscode:prepublish": "npm run compile && npm run compileBundle && npm run lint",
"clean": "rmdir-cli out",
Expand Down

0 comments on commit da1f6a8

Please sign in to comment.