ソースを参照

Fix folder name and README.

armink 7 年 前
コミット
81271e528b
6 ファイル変更7 行追加59 行削除
  1. 7 6
      README.md
  2. 0 0
      docs/index.md
  3. 0 0
      examples/SConscript
  4. 0 0
      examples/example_hello.c
  5. 0 29
      pkginfo/Kconfig
  6. 0 24
      pkginfo/package.json

+ 7 - 6
README.md

@@ -4,7 +4,7 @@
 
 > 说明:你需要在这里对项目进行简单的介绍,描述项目背景,当前现状、功能特点等等……
 
-这是一个在 RT-Thread 上,用于演示的 package 。展示了一个 package 大致包括哪些东西,以及对应的一些模版文件。
+这是一个在 RT-Thread 上,用于演示的 package 。展示了一个 package 大致包括的内容,以及对应的一些模版文件。
 
 ### 1.1 目录结构
 
@@ -12,10 +12,11 @@
 
 | 名称 | 说明 |
 | ---- | ---- |
-| doc | 文档目录 |
-| example | 例子目录,并有相应的一些说明 |
-| inc | 头文件目录 |
-| src | 源代码目录 |
+| docs  | 文档目录 |
+| examples | 例子目录,并有相应的一些说明 |
+| inc  | 头文件目录 |
+| src  | 源代码目录 |
+| port | 移植代码目录。如果没有移植代码,可以不需要 |
 
 ### 1.2 许可证
 
@@ -45,7 +46,7 @@ RT-Thread online packages
 
 ## 3、使用 hello
 
-> 说明:在这里简介使用流程,准备工作、API 等等。如果 package 需要做初始化,额外指出初始化步骤;或者指明对应导出的初始化宏
+> 说明:在这里介绍 package 的移植步骤、使用方法、初始化流程、准备工作、API 等等,如果移植或 API 文档内容较多,可以将其独立至 `docs` 目录下
 
 在打开 hello package 后,当进行 bsp 编译时,它会被加入到 bsp 工程中进行编译。
 

+ 0 - 0
doc/index.md → docs/index.md


+ 0 - 0
example/SConscript → examples/SConscript


+ 0 - 0
example/example_hello.c → examples/example_hello.c


+ 0 - 29
pkginfo/Kconfig

@@ -1,29 +0,0 @@
-config PKG_USING_HELLO
-    bool "hello: the hello example package"
-    default n
-
-if PKG_USING_HELLO
-
-    config PKG_HELLO_PATH
-        string
-        default "/packages/misc/hello"
-
-    choice
-        prompt "version"
-        default PKG_USING_HELLO_LATEST_VERSION
-        help 
-            Select the version of hello
-
-        config PKG_USING_HELLO_V100
-            bool "v1.0.0"
-
-        config PKG_USING_HELLO_LATEST_VERSION
-            bool "latest"
-    endchoice
-
-    config PKG_HELLO_VER
-        string
-        default "v1.0.0" if PKG_USING_HELLO_V100
-        default "latest" if PKG_USING_HELLO_LATEST_VERSION
-
-endif

+ 0 - 24
pkginfo/package.json

@@ -1,24 +0,0 @@
-{
-  "name": "hello",
-  "author" : "Bernard Xiong",
-  "description": "A hello package for rt-thread",
-  "keywords": [
-    "hello",
-    "example"
-  ],
-  "readme": "A hello package for rt-thread",
-  "license" : "LGPLv2.1",
-  "site": [
-    {
-      "version": "v1.0.0",
-      "URL": "https://github.com/BernardXiong/hello/archive/v1.0.0.zip",
-      "filename": "hello-1.0.0.zip"
-    },
-    {
-      "version": "latest",
-      "URL": "https://github.com/BernardXiong/hello.git",
-      "filename": "hello.zip",
-      "VER_SHA": "master"
-    }
-  ]
-}