update core app docs

arkedge · Mar 29, 2024 · 8b87caf · 8b87caf
1 parent 613ed99
commit 8b87caf
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -30,7 +30,7 @@ C2A に関する説明の棲み分けは，次のようになっています．
    1. [Overview](./general/overview.md)
    1. [Requirements](./general/requirements.md)
    1. [Release](./general/release.md)
-   1. [Build Options](./general/build_options.md)
+   1. [Build](./general/build.md)
    1. [Coding Rule](./general/coding_rule.md)
    1. [Coding Acronyms](./general/coding_acronyms.md)
 1. Application Layer

diff --git a/docs/application/overview.md b/docs/application/overview.md
@@ -34,3 +34,14 @@
 
 ## テレメトリ
 - アプリケーションの内部状態を送信するデータを規定する．
+
+## c2a-core Application の利用
+次のコンパイルオプションを `ON` とすることで，c2a-core の Application を利用できる．  
+https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt#L18-L20
+
+1. `C2A_USE_ALL_CORE_APPS`
+`ON` にすることで，全ての [c2a-core Application](/applications/) をビルドする．  
+その場合， `/src_user/applications/CMakeLists.txt` にビルドしたい c2a-core Application を適宜追加すること．  
+https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903d/examples/subobc/src/src_user/applications/CMakeLists.txt#L9-L13
+1. `C2A_USE_ALL_CORE_TEST_APPS`
+`ON` にすることで，全ての [c2a-core Test Application](/applications/test_app/) をビルドする．
diff --git a/docs/general/build_options.md → docs/general/build.md b/docs/general/build_options.md → docs/general/build.md
@@ -1,8 +1,14 @@
-# Build Options
+# Build
 
 ## 概要
-主なビルドオプション (Cmake Option) について説明する．  
-なお，ここに含まれているオプションは利用可能なオプションのうち，ごく一部であることに注意すること．
+ビルドに関連することをまとめる (TBW)．
+
+
+
+## Build Options
+C2A User から利用するビルドオプションは， [`/CMakeLists.txt`](/CMakeLists.txt) で定義される．  
+https://github.com/arkedge/c2a-core/blob/4472ef1a5670c2674f10b6b72b088d616367bd86/CMakeLists.txt
+
 
 
 ## [`/CMakeLists.txt`](/CMakeLists.txt)
@@ -29,9 +35,6 @@ https://github.com/arkedge/c2a-core/blob/459dbbf84d9587730f248ccbadb5a5745b28903
 `ON` にすることで，MOBC 向けの機能を有効化する．デフォルトは `OFF` であり， sub OBC 向けの実装となる．
 
 
-#### `C2A_USE_CORE_CCSDS_AOS_SPACE_DATA_LINK_PROTOCOL`, `C2A_USE_CORE_CCSDS_TC_SPACE_DATA_LINK_PROTOCOL`
-`ON` にすることで，CCSDS の AOS Space Data Link Protocol / TC Space Data Link Protocol の実装をビルドする．  
-[Core Layer/CCSDS](../core/ccsds.md) も参考のこと．
 
 
 ### その他