Skip to content

Commit d81d9a0

Browse files
committed
docs: split README into English and Japanese versions
1 parent e25bcad commit d81d9a0

File tree

2 files changed

+115
-55
lines changed

2 files changed

+115
-55
lines changed

README.ja.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# spacearth-dtn
2+
3+
![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)
4+
5+
**spacearth-dtn** は、Rustで書かれた遅延耐性ネットワーク(DTN)の実装です。
6+
宇宙から地上、また地上内の通信断環境でも機能する、**レジリエントな通信技術**を目指しています。
7+
8+
> "宇宙から地上へ。そして、通信断の世界へ。"
9+
10+
## 連絡先
11+
12+
質問、提案、貢献については以下までご連絡ください:
13+
- メール: [hsatlefp@gmail.com](mailto:hsatlefp@gmail.com)
14+
15+
---
16+
17+
## 機能
18+
19+
- 🌍 BPv7準拠のBundle Protocol
20+
- 🛰️ ストアアンドフォワード機構
21+
- 🔌 モジュラーCLA(Convergence Layer Adapter)設計
22+
- 📦 Bundleの永続化とメタデータ管理
23+
- 🛠️ LoRa、BLE、災害シナリオなどへの拡張性
24+
25+
---
26+
27+
## クイックスタート
28+
29+
### CLIツール
30+
31+
Bundle Protocolのバンドルを作成・管理するためのコマンドラインツールが利用可能です:
32+
33+
```bash
34+
# プロジェクトのビルド
35+
cargo build --release
36+
37+
# バンドルの作成
38+
spacearth-dtn insert --message "Hello, DTN!"
39+
40+
# すべてのバンドルを表示
41+
spacearth-dtn list
42+
43+
# バンドルの詳細表示(部分IDを使用)
44+
spacearth-dtn show --id <partial_id>
45+
46+
# すべてのバンドルを宛先に送信
47+
spacearth-dtn dispatch
48+
```
49+
50+
設定は`config/default.toml`で管理され、環境変数で上書き可能です:
51+
52+
```bash
53+
# 設定ファイルの指定
54+
export DTN_CONFIG="config/development.toml"
55+
56+
# 個別設定の上書き
57+
export DTN_BUNDLE_VERSION=8
58+
export DTN_ENDPOINTS_DESTINATION="dtn://new-dest"
59+
```
60+
61+
---
62+
63+
## 開発ロードマップ
64+
65+
現在の開発フェーズと今後の計画:
66+
67+
1.**Bundle構造・CBOR対応** (完了)
68+
- Bundle構造体の定義
69+
- CBORシリアライズ/デシリアライズ
70+
- 基本的なCLI操作
71+
72+
2.**Bundleの保存/ロード** (完了)
73+
- ファイルベースの永続化
74+
- BundleStore実装
75+
- 部分ID検索機能
76+
- テストの自動クリーンアップ
77+
- バンドルの送信機能
78+
79+
3. 🔜 **転送制御 (forwarding)** (次期)
80+
- 中継ノードでのルーティング
81+
- ルーティングルール実装
82+
83+
4. 🚧 **CLA (Convergence Layer Adapter)**
84+
- TCP/UDP通信
85+
- LoRa/BLE対応
86+
- HTTP/HTTPS対応
87+
88+
5. 🚧 **ソフトウェアバス**
89+
- プロセス間通信
90+
- メッセージキュー
91+
92+
6. 🚧 **イベントループ / タスク管理**
93+
- 非同期処理
94+
- タスクスケジューリング
95+
96+
7.**管理CLI / WebUI** (オプション)
97+
- 詳細な管理機能
98+
- 可視化ツール
99+
100+
8.**RFC準拠検証** (オプション)
101+
- RFC 9171準拠テスト
102+
- 相互運用性テスト
103+
104+
---
105+
106+
## ライセンス
107+
108+
MIT OR Apache-2.0
109+
110+
---
111+
112+
## AI生成コンテンツ
113+
114+
このプロジェクトの一部(README、コードコメント、サンプルロジック)は、AIツールを使用して共同作成または生成されています。
115+
すべてのコードは使用前に手動でレビューとテストが行われています。

README.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -116,58 +116,3 @@ MIT OR Apache-2.0
116116

117117
Some parts of this project (README, code comments, and sample logic) are co-authored or generated using AI tools.
118118
All code is manually reviewed and tested before use.
119-
120-
---
121-
122-
## 日本語説明(Japanese Section)
123-
124-
**spacearth-dtn** は、Rustで書かれた遅延耐性ネットワーク(DTN)の実装です。
125-
宇宙から地上、また地上内の通信断環境でも機能する、**レジリエントな通信技術**を目指しています。
126-
127-
### 連絡先
128-
129-
質問、提案、貢献については以下までご連絡ください:
130-
- メール: [hsatlefp@gmail.com](mailto:hsatlefp@gmail.com)
131-
132-
### 開発ロードマップ
133-
134-
1.**Bundle構造・CBOR対応** (完了)
135-
- Bundle構造体の定義
136-
- CBORシリアライズ/デシリアライズ
137-
- 基本的なCLI操作
138-
139-
2.**Bundleの保存/ロード** (完了)
140-
- ファイルベースの永続化
141-
- BundleStore実装
142-
- 部分ID検索機能
143-
- テストの自動クリーンアップ
144-
- バンドルの送信機能
145-
146-
3. 🔜 **転送制御 (forwarding)** (次期)
147-
- 中継ノードでのルーティング
148-
- ルーティングルール実装
149-
150-
4. 🚧 **CLA (Convergence Layer Adapter)**
151-
- TCP/UDP通信
152-
- LoRa/BLE対応
153-
- HTTP/HTTPS対応
154-
155-
5. 🚧 **ソフトウェアバス**
156-
- プロセス間通信
157-
- メッセージキュー
158-
159-
6. 🚧 **イベントループ / タスク管理**
160-
- 非同期処理
161-
- タスクスケジューリング
162-
163-
7.**管理CLI / WebUI** (オプション)
164-
- 詳細な管理機能
165-
- 可視化ツール
166-
167-
8.**RFC準拠検証** (オプション)
168-
- RFC 9171準拠テスト
169-
- 相互運用性テスト
170-
171-
今後、LoRa・BLEなどのCLA(通信層)との統合や、CLI・Web可視化ツールなども展開予定です。
172-
173-
開発初期フェーズにつき、Pull Request・Issue歓迎します!

0 commit comments

Comments
 (0)