Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document building and installing in the README #23

Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
# vscode-flowr
flowR Extension for Visual Studio Code
*flowR* Extension for Visual Studio Code. For more information on *flowR*, check out [the main repository](https://github.com/Code-Inspect/flowr).

## Features
TO DO
**This extension is still work in progress, as is this README. Please stay tuned for cool features and cooler documentation!**

## Requirements
TO DO
## Installing

## Extension Settings
TO DO
### From Visual Studio Marketplace
vscode-flowr is not available on the Visual Studio Marketplace yet. For now, we recommend installing from the artifact, or building from source.

# Developing
### From GitHub Releases
There are no official releases yet. Stay tuned!

## Git Hooks
### From build artifacts
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that I Don't Use Titlecase for these headers. The two headers above only appear that way because they use proper nouns!

You can easily download the most recent build of the extension by heading to the [Actions tab](https://github.com/Code-Inspect/vscode-flowr/actions/workflows/package.yml), where you will find a list of runs. Selecting the most recent run will display a summary of it, at the bottom of which you can find the Artifacts section and the `Extension vsix` artifact. Download it und unzip it.

From Visual Studio Code, open the Extensions tab and click on the three dots in the top right to select "Install from VSIX..." Alternatively, you can use the Command Palette to select the option directly. Then, you can select the `vscode-flowr-[version].vsix` file you unzipped to install it.
Ellpeck marked this conversation as resolved.
Show resolved Hide resolved

Ellpeck marked this conversation as resolved.
Show resolved Hide resolved
## Developing

### Building and running from source
Opening the repository in Visual Studio Code allows using the [existing launch configurations](https://github.com/Code-Inspect/vscode-flowr/blob/main/.vscode/launch.json) which can launch Visual Studio Code with the extension enabled. To use them, open the Run and Debug view and press the Run button at the top, or use the F5 shortcut to start debugging.
Ellpeck marked this conversation as resolved.
Show resolved Hide resolved
Ellpeck marked this conversation as resolved.
Show resolved Hide resolved

You can then open the [example folder](https://github.com/Code-Inspect/vscode-flowr/tree/main/example) contained in this repository to try out the extension for yourself.

To build the extension into a `vsix` file, see [this documentation article](https://code.visualstudio.com/api/working-with-extensions/publishing-extension).

### Git hooks
This repository contains some git hooks to ensure that linting and other actions happen. Register these hooks by running:
```sh
git config core.hooksPath .githooks
Expand Down
Loading