Skip to content

Commit

Permalink
apply suggestions and reorder the import/toolchain setup/runOnDevice/…
Browse files Browse the repository at this point in the history
…build steps
  • Loading branch information
nhouze-microej committed Jan 6, 2025
1 parent 95961d1 commit af90c89
Showing 1 changed file with 46 additions and 44 deletions.
90 changes: 46 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ The <VEE_PORT> is derived into:

## <VEE_PORT> Setup

### <VEE_PORT> Import

[Open the VEE Port project in your favorite IDE](https://docs.microej.com/en/latest/SDK6UserGuide/importProject.html)
by selecting the root folder of the cloned repository.

Expand All @@ -102,7 +100,7 @@ The project contains the following subprojects:
By default, the <VEE_PORT> is configured as a Mono-Sandbox Evaluation
<VEE_PORT> (Please refer to the [RELEASE NOTES](./RELEASE_NOTES.md) limitations section for more details).

### Run an Application on the Simulator
## Run an Application on the Simulator

To run an Application on the Simulator, the BSP or C/C++ Toolchain are not required.

Expand All @@ -122,48 +120,66 @@ An evaluation license is needed for building an Application. Please refer to
https://docs.microej.com/en/latest/SDK6UserGuide/licenses.html#evaluation-licenses
for information on how to acquire and activate a license.

### Run an Application on the Device
## Run an Application on the Device

To build and run the Application on the Device, the BSP are C/C++ Toolchain are required.
To build and run the Application on the Device, the BSP and C/C++ Toolchain are required.

Before continuing further, please refer to the [BSP Setup](#bsp-setup) section below to setup the toolchain.
- Run the `app` sample Application [on Device](https://docs.microej.com/en/latest/SDK6UserGuide/runOnDevice.html).
This automatically builds the <VEE_PORT> and uses it.
### Toolchain Setup

The build may take several minutes.
The first time, the <VEE_PORT> build requires to download modules that are available on the MicroEJ Central Repository.
Install the <BOARD_MANUFACTURER> toolchain as described [here](<board_toolchain_setup_documentation_url>).

Please wait for the Application start, or for the final message:
- Windows Toolchain
- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain [download link](<windows_toolchain_download_url>)

```sh
BUILD SUCCESSFUL
```
This step will build the BSP. If you would like to rebuild the BSP manually, please refer to the [BSP Compilation](#bsp-compilation) section below.
Please refer to the <BOARD_MANUFACTURER> documentation available [here](<manufacturer_windows_toolchain_setup_documentation_url>)
for more details.

- Linux Toolchain
- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain [download link](linux_toolchain_download_url>)

## BSP Setup
Please refer to the <BOARD_MANUFACTURER> documentation available [here](<manufacturer_linux_toolchain_setup_documentation_url>)
for more details.

Install the <BOARD_MANUFACTURER> toolchain as described [here](<board_toolchain_setup_documentation_url>).
### BSP Setup

### Windows Toolchain
The build scripts expect the toolchain to be installed at a known
location. You can configure it, if you installed it elsewhere, by overriding
environment variables. The environment variables are declared in the
`set_project_env*` script. They can be defined globally by the user or
in the `set_local_env*` scripts. When the `build.bat` (`build.sh`)
scripts is executed, the `set_local_env.bat` (`set_local_env.sh`) script
is imported if it exists. Create and configure these files to
customize the environment locally. Template files are provided as
example, see `set_local_env.bat.tpl` and `set_local_env.sh.tpl`.

- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain [download link](<windows_toolchain_download_url>)
_Note:_ Please refer to the following public documentation link to get more details on this part:
- [VEE Port BSP Connection specification](https://docs.microej.com/en/latest/VEEPortingGuide/platformCreation.html#bsp-connection)
- [VEE Port Creation Training](https://docs.microej.com/en/latest/Trainings/tutorialCreatePlatformBuildAndRunScripts.html)

Please refer to the <BOARD_MANUFACTURER> documentation available [here](<manufacturer_windows_toolchain_setup_documentation_url>)
for more details.
### Build and Run the Application

### Linux Toolchain
- Run the `app` sample Application [on Device](https://docs.microej.com/en/latest/SDK6UserGuide/runOnDevice.html).
This automatically builds the <VEE_PORT> and uses it.

- C/C++ toolchain name: <C/C++ toolchain name>
- C/C++ toolchain version: <C/C++ toolchain version>
- C/C++ toolchain [download link](linux_toolchain_download_url>)
The build may take several minutes.
The first time, the <VEE_PORT> build requires to download modules that are available on the MicroEJ Central Repository.
The <VEE_PORT> will also build the `bsp` project and link it with MicroEJ VEE and the Application to produce an executable.

Please refer to the <BOARD_MANUFACTURER> documentation available [here](<manufacturer_linux_toolchain_setup_documentation_url>)
for more details.
Please wait for the Application start, or for the final message:

```sh
BUILD SUCCESSFUL
```

### BSP Compilation
### BSP Manual Compilation

This section shows how to build the `bsp` project manually without having to rebuild the application.

Note: this can only be done if `buildExecutable` or `runOnDevice` have been called at least once, see [Run on Device](https://docs.microej.com/en/latest/SDK6UserGuide/runOnDevice.html)

To build the `bsp` project, open a
terminal and enter the following command lines:
Expand All @@ -188,20 +204,6 @@ The BSP project build is launched. Please wait for the final message:
To flash all build output, run 'make flash' or:
```

The build script expects the toolchain to be installed at a known
location. You can configure it, if you installed it elsewhere, by overriding
environment variables. The environment variables are declared in the
`set_project_env*` script. They can be defined globally by the user or
in the `set_local_env*` scripts. When the `build.bat` (`build.sh`)
scripts is executed, the `set_local_env.bat` (`set_local_env.sh`) script
is imported if it exists. Create and configure these files to
customize the environment locally. Template files are provided as
example, see `set_local_env.bat.tpl` and `set_local_env.sh.tpl`.

_Note:_ Please refer to the following public documentation link to get more details on this part:
- [VEE Port BSP Connection specification](https://docs.microej.com/en/latest/VEEPortingGuide/platformCreation.html#bsp-connection)
- [VEE Port Creation Training](https://docs.microej.com/en/latest/Trainings/tutorialCreatePlatformBuildAndRunScripts.html)

## Board Setup

Please refer to the <BOARD_MANUFACTURER> documentation available [here](<board_setup_documentation_url>)
Expand Down

0 comments on commit af90c89

Please sign in to comment.