Skip to content

Commit

Permalink
Add development documentation section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
D4N committed Mar 2, 2021
1 parent d3a36b4 commit d92842b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,26 @@ Install the extension from the Marketplace, execute the command `Preferences:
Product Icon Theme` and select the entry `EOS Icons` in the presented drop down:

![select_product_theme.png](select_product_theme.png)


## Development

To build the extension yourself, you will need the following packages installed:

- nodejs
- yarn
- python

and execute the following commands to setup your development environment:
```ShellSession
$ yarn install
$ yarn run prepare
```

To build the extension itself, execute `yarn run package`.

To try the extension out in VSCode, open this folder in VSCode and press `<f5>`
to launch a debugging session. This will create a fresh VSCode instance with the
extension pre-installed and loaded. Note that sometimes the icon theme is not
properly loaded on launch, in that case switch the Product Icon Theme to the
default and back to EOS Icons.

0 comments on commit d92842b

Please sign in to comment.