From 42e2d4dcd4ded1b679b7fbd887e58cd36771c177 Mon Sep 17 00:00:00 2001
From: Makiras <22570332+Makiras@users.noreply.github.com>
Date: Fri, 9 May 2025 19:26:04 +0800
Subject: [PATCH] update readme and ci condition

---
 .github/workflows/envbase.yaml |  4 +++
 README.md                      |  5 ++-
 tutorials/README.md            | 63 ++++++++++++++++++++++++++++++++++
 3 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 tutorials/README.md

diff --git a/.github/workflows/envbase.yaml b/.github/workflows/envbase.yaml
index 00d7320..4b52782 100644
--- a/.github/workflows/envbase.yaml
+++ b/.github/workflows/envbase.yaml
@@ -3,6 +3,10 @@ name: Basic Env Docker Build and Publish
 on:
   push:
     branches: [ "master" ]
+    paths:
+      - "docker/Dockerfile"
+      - "docker/Dockerfile.full"
+      - ".github/workflows/envbase.yaml"
   workflow_run:
     workflows: [ "envbase" ]
     branches: [ "master" ]
diff --git a/README.md b/README.md
index cd36446..7ba2def 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,15 @@ This repository contains everything needed to set up the Picker tool's complete
 │   ├── build-scripts/       # Automated build utilities
 │   └── compose/             # (Optional) Docker-compose files
 ├── tutorials/               # Workshop materials
-│   ├── ppt/                 # Presentation slides
+│   ├── README.md            # ** IF YOU ARE IN TUTORIAL, READ THIS FIRST**
+│   ├── slides/              # Presentation slides
 │   └── code-samples/        # Demo scripts
 ├── LICENSE
 └── README.md                 # This document
 ```
 
+**If you are in the tutorial, please read the [README.md](./tutorials/README.md) in the tutorials directory first.**
+
 ## 🚀 Getting Started
 
 ### Pre-built Docker Images 💿
diff --git a/tutorials/README.md b/tutorials/README.md
new file mode 100644
index 0000000..aeab336
--- /dev/null
+++ b/tutorials/README.md
@@ -0,0 +1,63 @@
+# README for Tutorial Audience
+
+## Download the Docker Image
+
+### Local Laptop
+
+If you want to run the image locally, it is recommended to use our local Wireless Hotspot to download the image, due to the internet connection speed. The Image is about 1GB, so it may take a while to download.  
+
+You can connect to the wifi hotspot with the following credentials:
+- **SSID**: `UnityChip`
+- **Password**: `UnityChip2025`
+
+Once connected, you can run the following command to download the image:
+```sh
+wget -O - http://192.168.100.2/envfull.tar.gz
+gzip -d envfull.tar.gz
+docker load -i envfull.tar
+```
+
+### Remote Server
+
+If you are using a remote server, you can download the Docker image from the GitHub Container Registry.
+```sh
+docker pull ghcr.io/xs-mlvp/envfull:latest
+```
+
+## Run the Docker Image
+
+### Shell Access
+
+If shell access is enough for you, run the image with the following command:
+```sh
+docker run -it --network host ghcr.io/xs-mlvp/envfull:latest 
+```
+
+If you want to use ssh or vscode remote development, run this command in the container:
+```sh
+sudo service ssh start
+```
+and go to the next section for SSH access. (no need to docker run again)
+
+### SSH Access
+
+If you want to use ssh or vscode remote development, run the image with the following command:
+```sh
+docker run -itd --network host ghcr.io/xs-mlvp/envfull:latest sudo /usr/sbin/sshd -D
+```
+
+Then, SSH into the container (security reason: /etc/ssh/sshd_config is set to only listen to localhost):
+```sh
+ssh -p 51202 user@localhost # password: user
+```
+
+If you are running the container on a remote server, you can use the following command for port forwarding when connecting to the remote server:
+```sh
+ssh -L 51202:localhost:51202 <your-server-user>@<your-remote-server-ip>
+```
+> Note: This step is optional if you are running the container on your local machine, it's map server port to localhost for security reason.
+
+### VSCode Remote Development
+
+If you want to use VSCode remote development, just use remote-ssh extension to connect to the container.
+