Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix README and add how to use for OSS #105

Merged
merged 5 commits into from
Jul 1, 2023

Conversation

200km
Copy link
Member

@200km 200km commented Jun 29, 2023

概要

Fix README and add how to use for OSS

Issue

詳細

OSS化に向けてREADMEを次のように修正した

  • 英語に翻訳
  • 一般ユーザーに対する使い方の追記
  • settingsディレクトリの追加
  • ExampleディレクトリにREADMEの追加

検証結果

Readmeだけなので関係なし

試験結果詳細記述場所 or 詳細ログ保存場所へのリンク

NA

影響範囲

NA

補足

NA

注意

NA

@200km 200km added this to the OSS公開 milestone Jun 29, 2023
@200km 200km self-assigned this Jun 29, 2023
@200km 200km requested a review from SeirenTDoi June 29, 2023 21:30
@SeirenTDoi
Copy link
Collaborator

@200km
For general usersのところについて2点あります。

  1. 以下の部分で2行目のexampleはExampleでしょうか?
    Users can refer to the c2a-aobc/Example directory to make a directory construction of c2a-aobc-hoge-satellite.
    NOTE Please rewrite the example to your project name.

  2. 以下のリンクがNot foundでした。
    How to build and execute the project-specific repository
    Please see the README.md in the Example directly.

@200km
Copy link
Member Author

200km commented Jun 30, 2023

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

以下の部分で2行目のexampleはExampleでしょうか?

これは表現が難しい部分なのですが、2行目のexampleは、この作業に関連するすべての「example表記(EXAMPLEやExampleも含む)をプロジェクト名に適切に変更して使ってください」というような意味合いです。(もう少し分かりやすい英文を考えてみます。)

以下のリンクがNot foundでした。

修正しておきます。

@200km
Copy link
Member Author

200km commented Jun 30, 2023

@SeirenTDoi Example周りの説明を修正したので、ご確認いただけると嬉しいです。

@SeirenTDoi
Copy link
Collaborator

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

こちらもこちらと同様に、project-nameリポジトリにsub moduleを追加する暗黙の指示があるという理解でよろしいでしょうか。

@200km
Copy link
Member Author

200km commented Jun 30, 2023

@SeirenTDoi ご質問いただいた部分は、s2e-aobcの方と同様に修正しました。こちらもぜひapproveまでお願いします。

@200km 200km merged commit ddd6e50 into develop Jul 1, 2023
@200km 200km deleted the feature/fix-readme-for-how-to-use branch July 3, 2023 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants