From 9b832f5e93b224d8f50fb74af19709cdfd39910a Mon Sep 17 00:00:00 2001 From: Bhuvaneshwari <59604451+bhuvaneshwarikanagaraj@users.noreply.github.com> Date: Wed, 25 Sep 2024 16:57:33 +0530 Subject: [PATCH] Update README.md --- README.md | 106 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 68 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index bb23962..eb3d751 120000 --- a/README.md +++ b/README.md @@ -1,59 +1,89 @@ -Hello World Setup with seL4 Tutorials -1.1 Setup with seL4-Tutorials-Manifest and Environment -Create a directory for the tutorials: -bash -mkdir sel4-tutorials-manifest -cd sel4-tutorials-manifest - -Initialize the repository: -bash +# Hello World Tutorial Setup with seL4-tutorials-manifest + +## 1.1 Setup with seL4-tutorials-manifest and Virtual Environment + +### Setup: + +- Create a new directory for the tutorial manifest: + + ```bash + mkdir sel4-tutorials-manifest + cd sel4-tutorials-manifest + ``` + +- Initialize and sync the repository: + +```bash repo init -u https://github.com/seL4/sel4-tutorials-manifest repo sync +``` -Create a virtual Python environment: -bash -python3 -m venv venv +### you should see something like this 👀 👀 👀 +======= +- Create a virtual Python environment and activate the environment -Activate the virtual environment: -bash +```bash +python3 -m venv venv source venv/bin/activate -Install required packages: -bash +``` + +### Dependencies: + +- Install setuptools + +```bash pip3 install setuptools +``` + +- Install seL4 dependencies + +```bash pip3 install sel4-deps +``` + +- Install CAmkES dependencies + +```bash pip3 install camkes-deps +``` -If only required, install additional packages: -bash -pip install aenum +- If only required, install additional packages: + +```bash +pip install aenum pip install sh +``` + +## 1.2 Building Your First Program -To deactivate the environment: -bash -deactivate +- Build the project using ninja: -Initialize the Hello World tutorial: -bash +```bash ./init --tut hello-world +``` + +- Navigate to the build directory: + +```bash cd hello-world_build +``` + +- Build the project using ninja: -1.2 Building Your First Program -Build the program using Ninja: -bash +```bash ninja +``` -Clean the build if necessary: -bash -ninja clean +- Clean the build using ninja: -Run the simulation: -bash -./simulate +```bash +ninja clean +``` -Output: -text -Booting all finished, dropped to user space -Hello, World! +- Simulate the program: -Terminate QEMU: Press Ctrl-A, then X. +```bash +ninja clean +``` +Screenshot 2024-09-25 at 16 18 55