Skip to content

Commit

Permalink
Added faq.md, install.md. Updated ReadMe.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
Galarius committed Mar 11, 2018
1 parent 8426137 commit 669752c
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 51 deletions.
9 changes: 9 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# FAQ

> Why `OpenCL: Info` command shows error?
The command needs OpenCL drivers and run-time libraries to be installed on your system. They can be obtained e.g. from [Intel](https://software.intel.com/en-us/articles/opencl-drivers).

> I am on Linux. Why can't I use `OpenCL: Info` command?
It is not supported for now.
19 changes: 19 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Installation Guide

## **I.** Install from the Extensions pane

1. Press `Ctrl+Shift+X` or `Cmd+Shift+X` to open the Extensions pane

2. Find and install the `OpenCL` extension

## **II.** Install from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=galarius.vscode-opencl)

Press `Install` button

## **III.** Install from the `.vsix` file

1. Download `vsix` package from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=galarius.vscode-opencl) (Press `Download Extension` link) or select the specific version of this extension from it's [Releases page](https://github.com/Galarius/vscode-opencl/releases)

2. In VS Code press `Ctrl+Shift+X` or `Cmd+Shift+X` to open the Extensions pane

3. Press at the right top corner of the pane and select `Install from VSIX...`
62 changes: 11 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@

This extension adds:

* `.cl` and `.ocl` file extensions support
* Support for file extensions: `.cl` and `.ocl`
* OpenCL C keywords syntax highlighting
* OpenCL C++ keywords syntax highlighting
* Auto-Completion (Built-in OpenCL functions, data types and macros)
* Code Snippets for some host and device functions
* Hover tooltip for OpenCL Runtime
* Code Snippets for some host and device functions ([list of functions](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/snippets/code.snippets.progress.md))
* Command `OpenCL: Info` to show OpenCL platforms/devices info. (`linux` is not supported yet)

|![screen-autocomplete](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-autocomplete.gif)|
Expand All @@ -19,6 +20,8 @@ This extension adds:
|*Code Snippets*|
|![vscode-opencl-cmd-oclinfo](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-cmd-oclinfo.gif)|
|*OpenCL platforms/devices info*|
|![vscode-opencl-cmd-oclinfo](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-hover.gif)|
|*Hover tooltip for OpenCL Runtime*|
||

## Prerequisites
Expand All @@ -34,71 +37,28 @@ In order to run command `OpenCL: Info` on Windows:
* Check that you have a device that supports OpenCL
* Make sure your OpenCL device driver is up to date. You can download drivers manually: [Intel](https://software.intel.com/en-us/articles/opencl-drivers), [NVidia](http://www.nvidia.com/Download/index.aspx), [AMD](http://support.amd.com/en-us/download)

## How To Install This Extension
## How To Install

### **I.** Install from the Extensions pane
See [INSTALL.md](https://github.com/Galarius/vscode-opencl/blob/master/INSTALL.md)

1. Press `Ctrl+Shift+X` or `Cmd+Shift+X` to open the Extensions pane

2. Find and install the `OpenCL` extension

### **II.** Install from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=galarius.vscode-opencl)

Press `Install` button

### **III.** Install from the `.vsix` file

1. Download `vsix` package from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=galarius.vscode-opencl) (Press `Download Extension` link) or select the specific version of this extension from it's [Releases page](https://github.com/Galarius/vscode-opencl/releases)

2. In VS Code press `Ctrl+Shift+X` or `Cmd+Shift+X` to open the Extensions pane

3. Press at the right top corner of the pane and select `Install from VSIX...`

## How To Use This Extension
## How To Use

* Open any `.cl` or `.ocl` file in VS Code to activate syntax highlighting, auto-completion and code snippets for OpenCL kernel files.

* Open any file associated with `C` or `C++` language in VS Code to activate code snippets for OpenCL functions.

## Contributing

There are plenty of possible improvements:

* Auto-Completion for OpenCL C++ Standard Library

* Documentation Hover View for OpenCL API

* More Code Snippets (check [current progress](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/snippets/code.snippets.progress.md))

* Check for [open issues](https://github.com/Galarius/vscode-opencl/issues)

Here's a quick guide on `pull requests`:

1. [Check for open issues](https://github.com/galarius/vscode-opencl/issues), or
open a fresh issue to start a discussion around a feature idea or a bug.
Opening a separate issue to discuss the change is less important for smaller
changes, as the discussion can be done in the pull request.
2. [Fork](https://github.com/galarius/vscode-opencl.git) this repository on GitHub, and start making your changes.
3. Push the change (it's recommended to use a separate branch for your feature).
4. Open a pull request.
5. I will try to merge and deploy changes as soon as possible, or at least leave
some feedback, but if you haven't heard back from me after a couple of days,
feel free to leave a comment on the pull request.
See [CONTRIBUTING.md](https://github.com/Galarius/vscode-opencl/blob/master/CONTRIBUTING.md)

## FAQ

> Why `OpenCL: Info` command shows error?
The command needs OpenCL drivers and run-time libraries to be installed on your system. They can be obtained e.g. from [Intel](https://software.intel.com/en-us/articles/opencl-drivers).

> I am on Linux. Why can't I use `OpenCL: Info` command?
It is not supported for now, but will be in future.
See [FAQ.md](https://github.com/Galarius/vscode-opencl/blob/master/FAQ.md)

## Change Log

See [CHANGELOG.md](https://marketplace.visualstudio.com/items/galarius.vscode-opencl/changelog)

## License

[MIT](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/LICENSE.txt)
See [LICENSE.txt](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/LICENSE.txt)

0 comments on commit 669752c

Please sign in to comment.