Update the file and folder structure.

samples/kernal_sample/CMakeLists.txt → .github/samples/kernal_sample/CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.20)
 project(kernal_sample
     LANGUAGES C)
 
-set(At_RTOS_PATH "../../")
+set(At_RTOS_PATH "../../../")
 
 include(${At_RTOS_PATH}/CMakeLists.txt)
 

script/auto-version.ps1 → .github/script/auto-version.ps1

@@ -1,5 +1,5 @@
 $VersionFile = "atos_version.h"
-$VersionPath = "../kernal/include"
+$VersionPath = "../../kernal/include"
 $FileContent = '/**
  * Copyright (c) Riven Zheng (zhengheiot@gmail.com).
  *

.github/workflows/kernal-sample.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: Build Kernal Sample CMake
         shell: bash
-        working-directory: samples/kernal_sample
+        working-directory: .github/samples/kernal_sample
         run: |
           cmake -S . -B build
           cmake --build build

.github/workflows/trigger-version-release.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Execute Version Script
         id: version
         shell: powershell
-        working-directory: script
+        working-directory: .github/script
         run: |
          $message = powershell.exe -ExecutionPolicy bypass .\auto-version.ps1
          echo "value=$message" >> "$env:GITHUB_OUTPUT"

README.md

@@ -7,9 +7,7 @@ The goal of the project is to explore and try to provide a lot useful interfaces
 If this project was useful to you, give it a ⭐️ and I'll keep improving it. moreover, you can share your ideas we can together improve it. Welcome PRs!!! 
 
 <p align="center">
-
 <img src="https://socialify.git.ci/At-EC/At-RTOS/image?description=1&descriptionEditable=At-RTOS%20is%20an%20open%20user-friendly%20real-time%20operating%20system.&font=KoHo&forks=1&issues=1&name=1&owner=1&pattern=Circuit%20Board&stargazers=1&theme=Dark" alt="At-RTOS" width="640" height="320" />
-
 </p>
 
 ## Introduction
@@ -26,6 +24,54 @@ If this project was useful to you, give it a ⭐️ and I'll keep improving it.
 * **Tiny footprint:** It's as low as 1KB ROM/few bytes of RAM.
 * **Learn Once, Write Anywhere:** We don't make assumptions about the rest of your technology stack, so you can develop new features in At-RTOS without rewriting existing code.
 
+## At-RTOS Structure
+
+```shell
+# At-RTOS source code tree
+At-RTOS
+├── arch
+│   ├── arch32
+│   │   └── arm
+│   │       └── cmsis
+│   │          └── include
+│   │              └── *.h
+│   ├── arch.h
+│   └── CMakeLists.txt
+├── clock
+│   ├── include
+│   │   └── clock_tick.h
+│   ├── clock_systick.c
+│   └── CMakeLists.txt
+├── port
+│   ├── include
+│   │   └── port.h
+│   ├── port_keil.c
+│   └── CMakeLists.txt
+├── include
+│   ├── atos_configuration.h
+│   └── CMakeLists.txt
+├── kernal
+│   ├── include
+│   │   ├── at_rtos.h
+│   │   ├── atos_version.h
+│   │   └── *.h
+│   ├── basic.c
+│   ├── event.c
+│   ├── kernal.c
+│   ├── kernal_thread.c
+│   ├── linker.c
+│   ├── list.c
+│   ├── mutex.c
+│   ├── queue.c
+│   ├── semaphore.c
+│   ├── thread.c
+│   ├── timer.c
+│   ├── trace.c
+│   └── CMakeLists.txt
+├── kernal_idle.c
+└── CMakeLists.txt
+```
+
 ## What's New
 
 [v1.0.0] Welcome to At-RTOS. v1.0.0 was released now. A basic RTOS feature was implemented in the kernal system, Pls enjoy it (: