Fix how to use for general users

[200km]

概要

Fix how to use for general users

Issue

#6

詳細

一般ユーザー向けに衛星固有レポジトリの作り方とその使い方の詳細を記述した。
example/dataディレクトリ内のiniファイルは、ExtLibrariesなどへのパスを変える必要があるので、コピーではなく全て新しく作ることにした。

また、本当はPRを分けよう思ったが次の修正も混ぜてしまったので合わせてレビューしてください。

• 英語を校正アプリにかけて修正した。
• s2e-aobc/data/initialize_filesのファイル名を最新s2e-coreのルールに揃えた

検証結果

exampleディレクトリを使った、ユーザー定義レポジトリ作成手順の正しさをローカルWindows環境で確認した。
ExtLibrariesの構築、ビルド、実行ができることを確認した。

影響範囲

NA

補足

NA

注意

NA

[suzuki-toshihir0]

問題ないと思います！

[SeirenTDoi]

@200km
細かいところですが、以下が初見でちょっと時間がかかりました

1. こちらの「s2e-aobc-hoge-satellite」はこちらの「s2e-aobc-example」に対応すると思いますので、単語が「s2e-aobc-example」に統一されている方がわかりやすいと思いました。

2. こちらのNOTE Please rewrite the example to your project name.にあるthe exampleはその1つ上の行のs2e-aobc/exampleのことだと思いますが、それに気づくのに少し時間がかかりました。1にも関連しますが、s2e-aobc/exampleが始めからs2e-aobc/s2e-aobc-exampleになっており、且つ元の指示が
   s2e-aobc/s2e-aobc-example directoryをコピーするだけの方がよりわかりやすいと思いました。そう思う理由はもう１つあり、「example」はCMakeLists.txtの中でも使われていますのでCMakeLists.txt側はexample、ディレクトリ名はs2e-aobc-exampleだとより区別しやすいと思いました。

[200km]

@SeirenTDoi コメントありがとうございます。

「s2e-aobc-example」に統一されている方がわかりやすいと思いました。

少し表現が難しいのですが、「s2e-aobc-example」をベースに「s2e-aobc-hoge-satellite」を作ってもらい（exampleという表記を適切なプロジェクト名に変えてもらい）、使ってくださいという意図でした。

２の方にも関係しますが、「サンプルコードでexampleやEXAMPLEとなっている表記はすべて、適切なプロジェクト名に変えてから使ってくださいね」というのがここで伝えたいことですので、もう少し英文を考えてみます。

[200km]

@SeirenTDoi Example周辺部分を修正しましたので、ご確認お願いします。

[SeirenTDoi]

@200km ありがとうございます。レビューはOKとさせてもらいます。

別件で質問ですが、For general usersに関して

1. こちらでフォルダ構造の作り方の説明があり、
2. こちらにThis repository includes the s2e-aobc with the git submoduleとあるのですが、
   実際は1と2の間に暗黙の指示として「s2e-aobc-project-nameリポジトリに s2e-aobcをsub moduleとして追加」があって、その結果2のReadMeとしては既にaddされているはずなのでincludeと表現されている、という理解でよいでしょうか。

[200km]

@SeirenTDoi ありがとうございます。ぜひ、approveもしていただけると嬉しいです！
ご質問いただいた点ですが、s2e-aobc/READMEを読んで、ユーザー独自のレポジトリであるs2e-aobc-project-nameを作った後は、s2e-aobc/example/READMEは、そのままs2e-aobc-project-name/READMEになると思います。そして、そのレポジトリを見た人からすると、s2e-aobc/example/READMEは関係なくREADMEを自然に読むべきなので、このような構成にしています。

実際は1と2の間に暗黙の指示として「s2e-aobc-project-nameリポジトリに s2e-aobcをsub moduleとして追加」があって

は暗黙ではなく、s2e-aobc/READMEの下記の部分で書いているつもりです。

- s2e-aobc (git submodule)
途中略
- To use `git submodule` features, please see the reference [Git Tools Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).

ここももう少し明確に書くよう修正してみます。

[200km]

@SeirenTDoi 修正しました。

[SeirenTDoi]

@200km ありがとうございます。c2aと共にapproveさせていただきました。