Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
agrojean-ledger committed Dec 14, 2023
1 parent 3463dbd commit 4d7c912
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 19 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.2]

### Changed

* Update README + displayed extension name.

## [0.3.1]

### Changed
Expand Down
39 changes: 24 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# ledger-vscode-extension
# Ledger Dev Tools

Provide a quick and easy way to build and test applications for [Ledger](https://www.ledger.com/) devices.
<img src="https://github.com/LedgerHQ/ledger-vscode-extension/blob/update-readme/resources/ledger-wordmark.png?raw=true" width="40%" height="40%"/><br/>

The extension uses Ledger's own [Alpine based Docker image](https://github.com/LedgerHQ/ledger-app-builder/blob/master/dev-tools/Dockerfile) to allow developers to setup a build and test environment in a few minutes.
![Visual Studio Marketplace Version](https://vsmarketplacebadges.dev/version-short/LedgerHQ.ledger-dev-tools.svg) ![Visual Studio Marketplace Installs](https://vsmarketplacebadges.dev/installs-short/LedgerHQ.ledger-dev-tools.svg) ![Visual Studio Marketplace Rating](https://vsmarketplacebadges.dev/rating-star/LedgerHQ.ledger-dev-tools.svg)

[VS Code](https://code.visualstudio.com/) extension that provides a quick and easy way to build and test applications for [Ledger](https://www.ledger.com/) devices.

The extension uses Ledger's own [Docker image](https://github.com/LedgerHQ/ledger-app-builder/blob/master/dev-tools/Dockerfile) to allow developers to setup a build and test environment in a few minutes.

* Build your app for all Ledger devices : Nano S, Nano S Plus, Nano X, Stax.
* Supports C and Rust apps.
Expand All @@ -17,24 +21,25 @@ The extension uses Ledger's own [Alpine based Docker image](https://github.com/L

Automatically add tasks to help you build, test and load your app on a physical device.
These tasks are accessible through the build task menu keyboard shortcut to avoid clicking around.

<p align="center">
<img src="https://github.com/LedgerHQ/ledger-vscode-extension/blob/main/resources/tasks.gif?raw=true" width="70%" height="70%"/>
</p>

### Sidebar

The tasks are all accessible through an easy to use sidebar menu.

<p align="center">
<img src="https://github.com/LedgerHQ/ledger-vscode-extension/blob/main/resources/sidebar.gif?raw=true" width="70%" height="70%"/>

</p>
### Status Bar

Status bar items to quickly identify :

* Which device you are currently building your app for.
* The status of the Ledger developer tools Docker image.

<p align="center">
<img src="https://github.com/LedgerHQ/ledger-vscode-extension/blob/main/resources/statusbar.gif?raw=true" width="70%" height="70%"/>

</p>
## Requirements

* [Docker](https://www.docker.com/) should be installed and running.
Expand All @@ -55,6 +60,10 @@ This extension contributes the following settings:

## Release Notes

## 0.3.2

* Update README + displayed extension name.

## 0.3.1

* Clean debug logs.
Expand Down Expand Up @@ -108,7 +117,7 @@ This extension contributes the following settings:
* Add icons to side bar root items.
* Add auto run of docker containers.

### 0.1.0
## 0.1.0

* Code refactoring.
* New tasks :
Expand All @@ -117,26 +126,26 @@ This extension contributes the following settings:
* On device functional tests,
* Device quick onboarding.

### 0.0.6
## 0.0.6

Fixes app detection for Windows.

### 0.0.5
## 0.0.5

Add multi-folder workspace support. User can now choose which app to build from a quickpick menu.

### 0.0.4
## 0.0.4

Adds container terminal task to side bar items.

### 0.0.3
## 0.0.3

Fixes workspace path in docker run task for Windows.

### 0.0.2
## 0.0.2

Add extension icon.

### 0.0.1
## 0.0.1

Initial release of the extension.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "ledger-dev-tools",
"displayName": "ledger-dev-tools",
"displayName": "Ledger Dev Tools",
"description": "Tools to accelerate development of apps for Ledger devices.",
"version": "0.3.1",
"version": "0.3.2",
"publisher": "LedgerHQ",
"license": "Apache",
"icon": "resources/ledger-square.png",
Expand Down
Binary file added resources/ledger-wordmark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4d7c912

Please sign in to comment.