Skip to content

Commit 23dd5d1

Browse files
committed
Docs update and removing large uneeded files from git tracking
1 parent 8b26d87 commit 23dd5d1

File tree

3 files changed

+8
-40
lines changed

3 files changed

+8
-40
lines changed

samples/modules/executorch/arm-fvp-tutorials/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# Arm FVP Tutorial
22

3-
This tutorial is to demonstrate how to run an exported Executorch model in the Arm FVP simulator.
3+
This tutorial is to demonstrate how to run an exported ExecuTorch model on an Arm device running Zephyr via the the Arm FVP simulator.
44

55
# Requirements
66

7-
Requires docker to be installed.
7+
Requires docker to be installed. While the CLI is sufficient to complete this tutorial, Docker Desktop offers a lot of useful features. Instructions for downloading and installing Docker and/or Docker Desktop can be found [here](https://docs.docker.com/desktop/). You should enable docker to utilizes ~60 GB of VM memory, enabling as much swap that fits within your system. This tutorial was tested and validated on a machine with 34.4GB RAM and 1TB of disk where docker VM was permitted 60GB VM memory and 100GB swap space.
88

99
# Quick Start Commands
1010

1111
<details>
1212

13-
Start the docker image:
13+
You can copy-paste the commands below to setup up and validate a working flow. Start the docker image with the following command:
1414

1515
```
1616
docker run -it --entrypoint /bin/bash --net=host -w /home/zephyruser/ rselagam/zephyr-armfvp:v8
1717
```
1818

19-
In the docker image, run the following to set up environment and executorch module of zephyr:
19+
Once in the docker image, run the following commands to set up environment and executorch module of zephyr. Please note that you should replace `<YOUR EMAL>` and `<YOUR USER NAME>` with appropriate GitHub credentials:
2020

2121
```
2222
git config --global user.email "<YOUR EMAIL>" && \
@@ -57,6 +57,9 @@ docker pull rselagam/zephyr-armfvp:v8
5757

5858
## Starting the docker image
5959

60+
61+
It's often advantageous to map a shared volume between the hsot machine and the running docker image. This allows a user to transfer files between the two seamlessly. In the commands below `workspace` from the current direct is mapped to `/workspace` within the docker container. This flag option can be omitted if file sharing is not needed.
62+
6063
### Linux/macOS
6164

6265
```
@@ -69,7 +72,7 @@ docker run -it --entrypoint /bin/bash --net=host -v "$(pwd)"/workspace:/workspa
6972
docker run -it --entrypoint /bin/bash --net=host -v "${PWD}\workspace:/workspace" -w /home/zephyruser/ rselagam/zephyr-armfvp:v8
7073
```
7174

72-
# Wokring inside the Docker image
75+
# Working inside the Docker image
7376

7477
## Setup (One time)
7578

-1.05 KB
Binary file not shown.

samples/modules/executorch/arm/hello_world/src/model_pte.h

Lines changed: 0 additions & 35 deletions
This file was deleted.

0 commit comments

Comments
 (0)