@@ -86,7 +86,7 @@ After installation, you need to activate the environment variables.
8686Run the following command each time you start a new PowerShell session:
8787
8888``` powershell
89- ~/.rt-env/env.ps1
89+ . ~/.rt-env/env.ps1
9090```
9191
9292** Option B: Auto Activation on Startup (Recommended)**
@@ -98,7 +98,7 @@ Create or edit a PowerShell configuration file to automatically activate the env
9898notepad $PROFILE
9999
100100# Add the following line to the file:
101- ~/.rt-env/env.ps1
101+ . ~/.rt-env/env.ps1
102102```
103103
104104** Configuration File Paths:**
@@ -233,7 +233,58 @@ The following are the parameter descriptions common to all installation scripts:
233233
234234## Env Usage Guide
235235
236- For detailed usage instructions, please refer to:
236+ After installation completes, follow these steps to start using RT-Thread ENV:
237+
238+ ### 1. Activate Environment
239+
240+ ** Windows (PowerShell):**
241+ ``` powershell
242+ # Manual activation each time
243+ . ~/.rt-env/env.ps1
244+
245+ # Or auto-activate on startup (recommended)
246+ # Add to PowerShell profile: ~/.rt-env/env.ps1
247+ ```
248+
249+ ** Linux/macOS (bash/zsh):**
250+ ``` bash
251+ # Manual activation each time
252+ source ~ /.rt-env/env.sh
253+
254+ # Or auto-activate on login (recommended)
255+ # Add to ~/.bashrc or ~/.zshrc: source ~/.rt-env/env.sh
256+ ```
257+
258+ ### 2. Install Toolchains
259+
260+ Use the ` sdk ` command to install required toolchains for your development board:
261+
262+ ``` bash
263+ # Run sdk command to install toolchains
264+ sdk
265+ ```
266+
267+ ### 3. Available Commands
268+
269+ After activation, you can use the following commands:
270+
271+ | Command | Description |
272+ | ---------| -------------|
273+ | ` menuconfig ` | Configure project (RT-Thread kernel, BSP) |
274+ | ` menuconfig -s ` | Configure RT-Thread ENV (packages, tools) |
275+ | ` pkgs ` | Package manager (update, upgrade packages) |
276+ | ` sdk ` | Toolchain manager (install toolchains) |
277+ | ` scons ` | Build project |
278+
279+ ### 4. Additional Tools
280+
281+ ** pyocd Installation** (optional, for debugging Cortex-M devices):
282+ ``` bash
283+ # After activation
284+ pip install pyocd
285+ ```
286+
287+ ### 5. For Detailed Usage Instructions, Please Refer to:
237288
238289- [ Env Tool Usage Guide] ( https://github.com/RT-Thread/rt-thread/blob/master/documentation/env/env.md )
239290- [ Env Official User Manual] ( https://www.rt-thread.org/document/site/#/development-tools/env/env )
0 commit comments