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

Corrections #56

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/Homepage/Journeys.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ export const Journeys = () => {
<div className="flex flex-wrap gap-y-8 md:gap-x-[3%] mt-16">
<JourneyCard
title="Increase transaction security"
description="transaction security, and bring your protocol to Ledger Live users"
description="and bring your protocol to Ledger Live users"
type="blockchain"
className="w-full md:w-[48.5%]"
/>
<JourneyCard
title="Connect a Ledger device to your application"
description="quickly, by implementing various transport protocols"
description="quickly by implementing various transport protocols"
type="wallet"
className="w-full md:w-[48.5%]"
/>
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/device-app/bolos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

These pages contain detailed documentation about the core features offered by BOLOS, and how they can be utilized by BOLOS applications and end-users. We'll discuss how BOLOS manages the master device seed and the device private key, and how it can be used for attestation purposes. We'll also describe the hardware architecture that is common between all BOLOS devices.

The operating system behind all Ledger personal security devices is called the Blockchain Open Ledger Operating System, or BOLOS for short. BOLOS provides a lightweight, open-source framework for developers to build source code portable applications that run in a secure environment. BOLOS is a way of turning hardware wallets into fully-fledged [personal security devices](./psd).
The operating system behind all Ledger personal security devices is called the Blockchain Open Ledger Operating System, or BOLOS for short. BOLOS is lightweight, and provides open-source services for developers to build source code portable applications that run in a secure environment. BOLOS is a way of turning hardware wallets into fully-fledged [personal security devices](./psd).

BOLOS allows users to review and install applications that let them do more with their cryptographic secrets, while protecting the device and other applications from malicious code. The key to BOLOS's open-source friendliness and ability to limit the exposure of user's cryptographic secrets to their apps is its [application isolation](./psd/application-isolation/) technology.

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/device-app/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Cards, Card } from 'nextra/components'

# Get a project going or just start experimenting

To get your project quickly started, we provide a complete framework made for developing Embedded Apps for our devices. This Framework contains:
To get your project quickly started, we provide a complete framework made for developing Embedded Apps for our devices. It contains:

- An App Boilerplate
- The Ledger Visual Studio Code extension
Expand Down
31 changes: 21 additions & 10 deletions pages/docs/device-app/quickstart/build-load.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,35 @@

With the [Ledger Framework](./framework), you can build and load Embedded Apps on Linux, Mac and Windows, very easily, with the Visual Code Ledger extension.

## Prerequisites
## Introduction

- Docker
- An X11 server
- Visual Studio Code
- [The Ledger extension in VS Code](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools)
The easiest way to develop your app is by using [Visual Studio Code](https://code.visualstudio.com/download), using:
- the [ Ledger Developer Tools](https://marketplace.visualstudio.com/items?itemName=LedgerHQ.ledger-dev-tools) in the Extensions Marketplace.
- a handy [Workspace](https://code.visualstudio.com/docs/editor/workspaces) to put all your Apps in.
It can be useful to benefit from how existing apps have been coded.
- [Docker]( https://www.docker.com/products/docker-desktop/) (not necessary for Linux), as well as
- An X11 server, such as [XQuartz](https://www.xquartz.org/) for Mac or VcXsrv (https://sourceforge.net/projects/vcxsrv/) for Windows
for windows

## How it works

## How-to build and load
The Extension does (nearly) everything. It:
- loads the Container in Docker, but you need Docker running beforehand, and it
- has all the tasks to build, load and test your app, on the Ledger or in the emulaor
- as well as the tools to eveluate your tests, delete the build files, and other maintenance tasks.

1. 1. Have Docker running. Note: Not needed on Linux because this is already a background task.
2. Open the [Boilerplate App](https://github.com/LedgerHQ/app-boilerplate) or your own App in Visual Studio Code
3. Use Ledger extension's sidebar menu or open the tasks menu with `ctrl + shift + b` (`command + shift + b` on a Mac) to conveniently execute actions:

## How-to

1. Have Docker running (except for Linux because this is already a background task).
2. With Visual Studio Code, open the [Boilerplate App](https://github.com/LedgerHQ/app-boilerplate) or your own App.
This opens the container in Docker
3. In XQuartz preferences, make sure connections from network client are allowed.
4. Use Ledger Developer Tools extension. When installed, it is in the Activity Bar. Click on it to open the tasks menu with `ctrl + shift + b` (`command + shift + b` on a Mac) to conveniently execute actions:
- To pull and run the Docker image chose `Run dev-tools image`
- To build your app chose `Build app`
- To load it to a device, chose `Load app on device`


For more information, or if you want to manually Build and Load your app, read the [Boilerplate App documentation](https://github.com/LedgerHQ/app-boilerplate).

## Actions flow
Expand Down