diff --git a/docs/WAMR-Zephyr.md b/docs/zephyr.md similarity index 98% rename from docs/WAMR-Zephyr.md rename to docs/zephyr.md index c9d3f1d..b337b11 100644 --- a/docs/WAMR-Zephyr.md +++ b/docs/zephyr.md @@ -4,7 +4,7 @@ ### Install Dependencies on your development machine -Update your system: +Update your system. For debian based systems you can use the following command: ```bash sudo apt update @@ -32,23 +32,38 @@ Ensure versions meet the minimum requirements: CMake 3.20.5, Python 3.10, and De ### Get Zephyr and Python Dependencies on your development machine -Create a Zephyr workspace and clone the repository: +Install Python venv package:: ```bash -west init ~/zephyrproject -cd ~/zephyrproject -west update +sudo apt install python3-venv ``` -Set up a Python virtual environment: +Create a new virtual environment: ```bash -sudo apt install python3-venv python3 -m venv ~/zephyrproject/.venv +``` + +Activate the virtual environment: + +```bash source ~/zephyrproject/.venv/bin/activate +``` + +Install west: + +```bash pip install west ``` +Create a Zephyr workspace and clone the repository: + +```bash +west init ~/zephyrproject +cd ~/zephyrproject +west update +``` + Export Zephyr CMake package: ```bash diff --git a/mkdocs.yml b/mkdocs.yml index 81bf3c4..9f172d0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,3 +23,4 @@ nav: - Manager: manager.md - Proplet: proplet.md - Developer's Guide: developer-guide.md + - Zephyr: zephyr.md