Skip to content

Commit

Permalink
New feature description and gif image added.
Browse files Browse the repository at this point in the history
  • Loading branch information
Galarius committed Oct 29, 2017
1 parent 9154587 commit f9ed6e0
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 11 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
out
node_modules
.DS_Store
.DS_Store
*.vsix
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
## Version 0.1.3: October 29, 2017

Added command `OpenCL: Info` to show OpenCL platforms/devices info.
The command is activated when a file with any of the supported extensions (`.cl`,`.ocl`,`.c`,`.cpp`) is opened.

![vscode-opencl-cmd-oclinfo](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-cmd-oclinfo.gif)

*Only Win32 and macOS are supported.*

*Requirements: OpenCL drivers and runtime libraries.*

## Version 0.1.2: October 3, 2017

Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,28 @@ This extension adds:
* Code Snippets for some host and device functions
* 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)
*Syntax Highlighting, Auto-Completion*

![screen-snippet](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-snippet.gif)
*Code Snippets*
|![screen-autocomplete](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-autocomplete.gif)|
|-|
|*Syntax Highlighting, Auto-Completion*|
|![screen-snippet](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-snippet.gif)|
|*Code Snippets*|
|![vscode-opencl-cmd-oclinfo](https://raw.githubusercontent.com/Galarius/vscode-opencl/master/images/vscode-opencl-cmd-oclinfo.gif)|
|*OpenCL platforms/devices info*|
||

## Prerequisites

*[Required]*

* [Visual Studio Code](https://code.visualstudio.com)

*[Optional]*

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

### **I.** Install from the Extensions pane
Expand Down Expand Up @@ -73,7 +85,17 @@ Here's a quick guide on `pull requests`:
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.

## OpenCL for Visual Studio Code Change Log
## 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.

## Change Log

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

Expand Down
Binary file added images/vscode-opencl-cmd-oclinfo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
"activationEvents": [
"onLanguage:opencl",
"onLanguage:c",
"onLanguage:cpp"
"onLanguage:cpp",
"onCommand:opencl.info"
],
"main": "./out/extension",
"contributes": {
Expand Down
4 changes: 2 additions & 2 deletions src/oclinfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function execute(command: string): Promise<Buffer> {
return result.stdout;
}).fail(function(error) {
console.error("Error: " + error);
vscode.window.showErrorMessage("Error: " + error);
vscode.window.showErrorMessage(error);
}).progress(function(childProcess) {
console.log("Command: " + command + " running...");
});
Expand All @@ -52,7 +52,7 @@ export function oclinfoDumpAll() {
vscode.window.showTextDocument(doc);
}, (error: any) => {
console.error(error);
vscode.window.showErrorMessage("Error: " + error);
vscode.window.showErrorMessage(error);
});
});
} else {
Expand Down

0 comments on commit f9ed6e0

Please sign in to comment.