Merge pull request #1 from Guohezu001/main

init_store: a tool similar to "Buildroot" that can automatically compile and generate an image for flashing onto an SD card.

Author: BernardXiong

.gitignore

@@ -0,0 +1,36 @@
+# 可执行文件
+*.exe
+*.dll
+*.so
+*.elf
+*.bin
+*.hex
+*.axf
+*.pdb
+
+# 对象文件和库文件
+*.o
+*.obj
+*.lib
+*.a
+
+# 编译相关的临时文件
+*.dep
+*.i
+*.d
+*.dfinish
+*.su
+*.bak
+*.old
+*.crf
+*.dblite
+
+# xmake 相关
+build/
+.xmake/
+xmake.lua.bak
+xmake.lua~
+xmake_require_lock.lua
+xmake_requires.lua
+xmake_requires_lock.lua
+xmake_logs/

README.md

@@ -1,2 +1,89 @@
-# smart-build
-build kernel/rootfs/bootloader for rt-smart
+# 介绍与快速入门
+
+> 本文档环境为 `ubuntu 20.04`
+
+## 介绍
+
+### RT-Thread-Smart
+
+RT-Thread Smart（以下简称 Smart） 是基于 RT-Thread 操作系统上的混合操作系统，简称为 rt-smart，它把应用从内核中独立出来，形成独立的用户态应用程序，并具备独立的地址空间（32 位系统上是 4G 的独立地址空间）。详细信息请见 [RT-Thread 文档中心](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-smart/introduction/rt-smart-intro/rt-smart-intro)
+
+### Xmake
+
+xmake 是一个基于 Lua 的轻量级跨平台构建工具，使用 xmake.lua 维护项目构建，相比 makefile/CMakeLists.txt，配置语法更加简洁直观，对新手非常友好，短时间内就能快速入门，能够让用户把更多的精力集中在实际的项目开发上。详细信息请见 [Xmake 文档中心](https://xmake.io/#/zh-cn/about/introduction)
+
+## 快速入门
+
+ ![image-20241211512457800](./assets/image-20241211512457800.png)
+
+> 此次以 qemu-virt64-aarch64 为例讲解
+
+1. **安装 xmake及kconfiglib库**
+
+   请根据 [xmake 官方文档](https://xmake.io/#/zh-cn/guide/installation?id=ubuntu) 进行安装。
+
+   以下为 ubuntu 安装方式
+
+   ```shell
+   sudo add-apt-repository ppa:xmake-io/xmake
+   sudo apt update
+   sudo apt install xmake
+   pip install kconfiglib
+   ```
+
+2. **克隆仓库**
+
+   将 Smart 的 userapps 仓库克隆下来, 假定我们的工作路径是 `$WS`：
+
+   ```shell
+   cd $WS
+   git clone https://github.com/RT-Thread/smart-build.git
+   ```
+
+3. **选择我们想要编译的开发板及应用**
+
+   文件系统由多个应用程序组成，这些应用程序都放在 `apps` 目录下。由于 smart 采用 xmake 编译用户态环境，因此 smart 的编译方式非常简单。
+
+   首先进入 userapps 并运行 `env.sh` 添加一下环境变量。
+
+   ```shell
+   cd $WS/userapps
+   source ./env.sh
+   ```
+
+   进入 models 目录进行选择
+
+   ```shell
+   cd models
+   xmake menu #进入菜单选择界面
+   ```
+
+   ![image-20241211173829621](./assets/image-20241211173829621.png)
+
+   目前支持的平台：arm、aarch64、riscv64gc。
+
+   ![image-20230531173059551](./assets/image-20230531173059551.png)
+
+
+4. **制作镜像文件**
+
+   运行 `xmake` 制作image镜像，所谓制作文件系统，就是将上一步编译生成的用户程序按照文件系统的布局拷贝到 `$WS/userapps/models/build/rootfs` 路径下，并根据提前写好的on_run.lua脚本打包生成特定格式的 image 文件。
+
+   ```shell
+   xmake
+   ```
+
+   目前支持的镜像格式包括 ext4/fat/cromfs。
+
+   这里的例子会在 `$WS/userapps/models/build` 路径下生成 `ext4.img` 文件。
+
+   ![image-20241211512457899.png](./assets/image-20241211512457899.png)
+
+## prebuilt 的版本
+
+会在每天凌晨生成 aarch64/riscv64 for qemu 的 prebuilt 版本，包括内核和 rootfs 文件系统：
+
+- [aarch64](https://download-redirect.rt-thread.org/download/rt-smart/prebuilt/qemu-virt64-aarch64_latest.tar.gz)
+- [riscv64](https://download-redirect.rt-thread.org/download/rt-smart/prebuilt/qemu-virt64-riscv_latest.tar.gz)
+
+可以使用 qemu 来运行起来。

apps/busybox/xmake.lua

@@ -0,0 +1,33 @@
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- You may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2022-2023 RT-Thread Development Team
+--
+-- @author      xqyjlj  
+-- @file        xmake.lua
+--
+-- Change Logs:
+-- Date           Author       Notes
+-- ------------   ----------   -----------------------------------------------
+-- 2023-06-21     xqyjlj       initial version
+--
+
+add_rules("mode.debug", "mode.release")
+
+add_requires("busybox")
+
+target("busybox")
+do
+    set_kind("phony")
+    add_packages("busybox")
+end
+target_end()

apps/cpp/main.cpp

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2006-2018, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: GPL-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-10-20     Bernard      The first version
+ */
+
+#include <iostream>
+using namespace std;
+
+int main()
+{
+    cout << "Hello, World!" << endl;
+    return 0;
+}

apps/cpp/xmake.lua

@@ -0,0 +1,31 @@
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- You may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2022-2023 RT-Thread Development Team
+--
+-- @author      xqyjlj
+-- @file        xmake.lua
+--
+-- Change Logs:
+-- Date           Author       Notes
+-- ------------   ----------   -----------------------------------------------
+-- 2023-03-10     xqyjlj       initial version
+--
+add_rules("mode.debug", "mode.release")
+
+target("cpp_tc")
+do
+    add_rules("rt.cpp")
+    add_files("*.cpp")
+    add_values("rt.rootfs.prefixdir", "/tc")
+end
+target_end()

apps/ffmpeg/xmake.lua

@@ -0,0 +1,33 @@
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- You may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2022-2023 RT-Thread Development Team
+--
+-- @author      zbtrs  
+-- @file        xmake.lua
+--
+-- Change Logs:
+-- Date           Author       Notes
+-- ------------   ----------   -----------------------------------------------
+-- 2023-08-09     zbtrs       initial version
+--
+
+add_rules("mode.debug", "mode.release")
+
+add_requires("ffmpeg")
+
+target("ffmpeg")
+do
+    set_kind("phony")
+    add_packages("ffmpeg")
+end
+target_end()

apps/hello/main.c

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2006-2018, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: GPL-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-10-20     Bernard      The first version
+ */
+
+#include <stdio.h>
+
+int main(int argc, char **argv)
+{
+    printf("hello world!\n");
+
+    return 0;
+}

apps/hello/xmake.lua

@@ -0,0 +1,29 @@
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- You may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2022-2023 RT-Thread Development Team
+--
+-- @author      xqyjlj  
+-- @file        xmake.lua
+--
+-- Change Logs:
+-- Date           Author       Notes
+-- ------------   ----------   -----------------------------------------------
+-- 2023-03-10     xqyjlj       initial version
+--
+add_rules("mode.debug", "mode.release")
+
+target("hello")
+do
+    add_files("*.c")
+end
+target_end()

apps/micropython/xmake.lua

@@ -0,0 +1,32 @@
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- You may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2022-2023 RT-Thread Development Team
+--
+-- @author      xqyjlj
+-- @file        xmake.lua
+--
+-- Change Logs:
+-- Date           Author       Notes
+-- ------------   ----------   -----------------------------------------------
+-- 2023-06-21     xqyjlj       initial version
+--
+add_rules("mode.debug", "mode.release")
+
+add_requires("micropython")
+
+target("micropython")
+do
+    set_kind("phony")
+    add_packages("micropython")
+end
+target_end()