Skip to content

Commit 0f9c61c

Browse files
committed
Added workspace stuff, fixed some links.
1 parent 3f512b4 commit 0f9c61c

5 files changed

Lines changed: 83 additions & 8 deletions

File tree

docs/architecture/containers/container_image_manifest/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 1
77

88
# Container Image Manifest
99

10-
The Container Image Manifest is a crucial component of Ocre containers, providing a comprehensive description of the container's structure and contents. It serves as the blueprint that defines and references the *three* main elements of an Ocre container: [*Container Configuration*](../components/container_configuration), a [*WebAssembly Module*](../components/webassembly_module), and (optional) [*Binary Objects*](../components/binary_objects). The manifest ensures that all components can be correctly deployed and executed by the [Ocre Runtime](../../runtime/overview/index.md).
10+
The Container Image Manifest is a crucial component of Ocre containers, providing a comprehensive description of the container's structure and contents. It serves as the blueprint that defines and references the *three* main elements of an Ocre container: [*Container Configuration*](../components/container_configuration), a [*WebAssembly Module*](../components/webassembly_module), and (optional) [*Binary Objects*](../components/binary_objects). The manifest ensures that all components can be correctly deployed and executed by the [Ocre Runtime](../../runtime).
1111

1212
---
1313

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Setting Up Your Development Environment
3+
layout: default
4+
parent: Building and Flashing the Ocre Runtime
5+
nav_order: 0
6+
---
7+
8+
# Setting Up Your Development Environment
9+
10+
This page will guide you through setting up your development environment for the Ocre runtime using our preconfigured VS Code workspace file. The workspace file provides everything you need to build, flash, and debug the runtime with minimal configuration.
11+
12+
---
13+
14+
## What is a VS Code Workspace?
15+
16+
A Visual Studio Code workspace allows you to manage multiple folders, settings, and tasks as a single, cohesive environment. Workspaces can save you time by automatically loading recommended settings, extensions, and tasks suited for your project. If you're new to workspaces, we recommend reviewing the [VS Code Workspaces documentation](https://code.visualstudio.com/docs/editor/workspaces) to learn more about their features and usage.
17+
18+
---
19+
20+
## What’s in the "Ocre Workspace" File?
21+
22+
The Ocre runtime workspace file, [**`ocre.code-workspace`**](https://github.com/project-ocre/ocre-runtime/blob/main/ocre.code-workspace), is specifically tailored to help you set up and work with the Ocre runtime efficiently. Located in the root of the repository, this file includes:
23+
24+
1. **West Tasks:**
25+
The workspace file includes a predefined West tasks, which simplifies the process of building and flashing the Ocre runtime. These tasks support several board options, which can be selected directly within VS Code.
26+
27+
2. **Recommended Extensions:**
28+
The workspace file also includes extensions that provide additional support for tasks such as code completion, serial communication, and debugging. In general it's recommended to install the plugins found in the workspace file when prompted.
29+
30+
3. **Debugging Profiles:**
31+
The workspace file also includes debugging profiles specifically for Ocre-compatible boards. These profiles are configured to simplify launching and debugging sessions, so you can quickly load and test the runtime on your target hardware.
32+
33+
---
34+
35+
## How to Use the "Ocre Workspace" File
36+
37+
This section will guide you through running the essential pre-defined tasks in the Ocre workspace file, including build, flash, and debug operations. These tasks make it easy to quickly set up your development environment for various Ocre-compatible boards without needing to configure each setting manually.
38+
39+
### Running Build and Flash Tasks
40+
41+
The workspace file includes tasks for both building and flashing the Ocre runtime. Follow these instructions to access and run these tasks:
42+
43+
1. Press `Ctrl + Shift + P` (Windows/Linux) or `Command + Shift + P` (Mac) to open the **Command Palette**.
44+
2. Type `Tasks: Run Task`, select it from the list, and press `Enter`.
45+
3. Choose either **West Build** or **West Flash Application** from the task list.
46+
47+
When prompted, select the board you want to build or flash for, and the workspace file will handle the rest.
48+
49+
### Debugging with Predefined Profiles
50+
51+
The workspace also includes debugging profiles configured for Ocre-compatible boards. To start a debug session:
52+
53+
1. Open the **Run and Debug** view in VS Code by clicking the play icon on the sidebar or pressing `Ctrl + Shift + D` (Windows/Linux) or `Shift + Command + D` (Mac).
54+
2. In the dropdown menu, select the debug profile that matches your target board.
55+
3. Click "Start Debugging" or press `F5` to begin a session. The debugger will launch with the appropriate settings for your board, streamlining the process for testing and troubleshooting.
56+
57+
With these tasks, you can easily build, flash, and debug the Ocre runtime in a consistent and streamlined manner across different Ocre-compatible devices.
58+
59+
---
60+
61+
## Next Steps
62+
63+
With your development environment configured, you're ready to start building the Ocre runtime. Choose your development path below:
64+
65+
- [Build for a Simulated Device](../simulated)
66+
- [Build for a Physical Device](../hardware)

docs/quickstart/firmware/hardware.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Using a Physical Device
33
layout: default
44
parent: Building and Flashing the Ocre Runtime
5-
nav_order: 1
5+
nav_order: 2
66
---
77

88
# Using a Physical Device
99

1010
This guide covers building and flashing the Ocre runtime onto actual development boards. While simulated environments are great for initial testing, deploying to real hardware allows you to test your applications under authentic conditions and take advantage of board-specific features like sensors and networking capabilities.
1111

12-
Please refer to the board-specific documentation in our [Board Support](../../board-support) section for detailed setup instructions and requirements for your board before attempting to flash Ocre.
12+
Please refer to the board-specific documentation in our [Board Support](../../../board-support) section for detailed setup instructions and requirements for your board before attempting to flash Ocre.
1313

1414
---
1515

@@ -78,8 +78,7 @@ To build and flash for a physical device, follow these steps:
7878
```
7979

8080
{: .note}
81-
See the list of [supported boards](https://docs.zephyrproject.org/3.7.0/boards/index.html) from Zephyr to gather your board name. Or, simply run `west boards` from the terminal.
82-
81+
You can also run the **West Build** task directly from the **Ocre Workspace** file as defined in the [Setting Up Your Development Environment](../dev-environment) section. If you do, be sure to select your board name as your build target. See the [Board Support](../../../board-support) section in your docs to see if your board is currently supported.
8382

8483
### **6. Flash the Ocre Runtime to Your Device**
8584
1. Flash the application to your device:
@@ -94,4 +93,4 @@ After flashing, restart/reset your board to run the application.
9493
## Troubleshooting
9594
This section covers common issues you might encounter when building and flashing the Ocre runtime to physical hardware, along with their solutions.
9695

97-
- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [supported boards](../../board-support), check out our [Adding Board Support](../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware.
96+
- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [Board Support](../../../board-support), check out our [Adding Board Support](../../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware.

docs/quickstart/firmware/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,11 @@ has_children: true
1010

1111
This section will guide you through the process of building the Ocre runtime from source. Whether you're using a simulated environment for testing or deploying to physical hardware, the initial setup and build steps are identical. The paths diverge only at the final stage: simulated devices simply run the runtime directly, while physical devices require an additional flashing step to load the runtime onto the board.
1212

13-
To help you get started, we've included a sample application (`./src/main.c`) that demonstrates basic Ocre runtime usage by writing a simple hello world application to flash and directing the runtime to load and execute it. Choose your preferred development path below to begin.
13+
{: .note}
14+
To streamline your development workflow, check out our section on [Setting Up Your Development Environment](dev-environment) just before continuing. There, we walk you through using the "Ocre Workspace" file provided in our repository. This VS Code workspace file includes preconfigured `west` build commands for all supported boards, along with debugging utilities and other helpful settings to make building and flashing the Ocre runtime easier.
15+
16+
---
17+
18+
## Sample App
19+
20+
To help you get started, we've included a sample application (`./src/main.c`) that demonstrates basic Ocre runtime usage by writing a simple hello world application to flash and directing the runtime to load and execute it.

docs/quickstart/firmware/simulated.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Using a Simulated Device
33
layout: default
44
parent: Building and Flashing the Ocre Runtime
5-
nav_order: 0
5+
nav_order: 1
66
---
77

88
# Using a Simulated Device
@@ -82,6 +82,9 @@ The following will build the firmware for the *virtual*, `native_sim` target whi
8282
west build -b native_sim ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/application
8383
```
8484

85+
{: .note}
86+
You can also run the **West Build** task directly from the **Ocre Workspace** file as defined in the [Setting Up Your Development Environment](../dev-environment) section. If you do, be sure to select `native_sim` as your build target.
87+
8588
### **6. Run the application**
8689

8790
To run the application, simply run the following command:

0 commit comments

Comments
 (0)