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

Move gifs to client readme #81

Merged
merged 4 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
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
20 changes: 0 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,6 @@

The changelog for the extension can be found [here](./client/CHANGELOG.md).

## Demo

### Basic suggestions for variables, tasks, variable flags, overrides and more.

![Variables](assets/demo/basic-variable.gif)
![Tasks](assets/demo/yocto-tasks.gif)
![Variable-flags](assets/demo/variable-flag.gif)
![Overrides](assets/demo/overrides.gif)
![Directive-statements](assets/demo/directive-statements.gif)
### Go to definition for directive statements

![Go-to-definition](assets/demo/go-to-definition.gif)

### Show information on hover

![Hover](assets/demo/hover-information.gif)





## Installing from [VS Code Extension Marketplace](https://marketplace.visualstudio.com/VSCode)

Expand Down
Binary file removed assets/demo/basic-variable.gif
Binary file not shown.
Binary file removed assets/demo/directive-statements.gif
Binary file not shown.
Binary file removed assets/demo/go-to-definition.gif
Binary file not shown.
Binary file removed assets/demo/hover-information.gif
Binary file not shown.
Binary file removed assets/demo/overrides.gif
Binary file not shown.
Binary file removed assets/demo/variable-flag.gif
Binary file not shown.
Binary file removed assets/demo/yocto-tasks.gif
Binary file not shown.
19 changes: 19 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ The following suggestions are currently supported:
* Context-based suggestions for keywords `inherit`, `require` and `include` (provided by *language-server*)
* Context-based suggestions for all symbols within the include hierarchy

![Directive-statements](doc/directive-statements.gif)

### Go to definition
*This functionnality requires to [provide the BitBake's folder](#set-bitbakes-path)*
WilsonZiweiWang marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -49,11 +51,28 @@ The go to definition feature currently behaves as follows:
| recipe | recipe definition and all bbappends |
| symbol | all symbols within the include hierarchy |

![Go-to-definition](doc/go-to-definition.gif)

### Show definitions of BitBake's defined variables on hover
*This functionnality requires to [provide the BitBake's folder](#set-bitbakes-path)*
WilsonZiweiWang marked this conversation as resolved.
Show resolved Hide resolved

Place your cursor over a variable. If it is a BitBake defined variable, then its definition from the documentation will be displayed.

![Hover](doc/hover-information.gif)

### Other code suggestions
You can trigger the override suggestions with the shortcut or by typing a `:` after an variable name or function name.
WilsonZiweiWang marked this conversation as resolved.
Show resolved Hide resolved

![Overrides](doc/overrides.gif)
WilsonZiweiWang marked this conversation as resolved.
Show resolved Hide resolved

Variable flag suggestions can be triggered by typing a `[`:

![Variable-flags](doc/variable-flags.gif)

Frequently-used task names:

![Tasks](doc/yocto-tasks.gif)
WilsonZiweiWang marked this conversation as resolved.
Show resolved Hide resolved

### BitBake tasks

BitBake build tasks may be defined through the `tasks.json` file. They allow to build or a run any specific BitBake command on a set of recipes. This feature requires to have properly [configured the extension](#setup-the-extension). Learn how to use VSCode tasks [on the official Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/tasks).
Expand Down
Binary file added client/doc/directive-statements.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/doc/go-to-definition.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/doc/hover-information.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/doc/overrides.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/doc/variable-flags.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added client/doc/yocto-tasks.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading