Skip to content

READMEの更新 #12

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

Merged
merged 9 commits into from
Dec 24, 2021
Merged

READMEの更新 #12

merged 9 commits into from
Dec 24, 2021

Conversation

ShotaAk
Copy link

@ShotaAk ShotaAk commented Dec 24, 2021

What does this implement/fix?

  • GitHubのCIを手動実行から自動実行に変更します
  • トップのREADMEにCIのステータスバッジを追加します
  • READMEにYouTube動画のサムネイルとリンクを貼ります

Does this close any currently open issues?

いいえ

How has this been tested?

READMEをGitHub上で開き、バッジと動画サムネイルが表示されていることを確認しました

Any other comments?

Checklists

  • I have read the CONTRIBUTING guidelines.
  • I have checked to ensure there aren't other open Pull Requests for the same change.

@ShotaAk ShotaAk added the Type: Documentation Documentation only changes label Dec 24, 2021
@ShotaAk ShotaAk requested a review from Tiryoh December 24, 2021 03:05
@Tiryoh Tiryoh self-assigned this Dec 24, 2021
@Tiryoh
Copy link
Contributor

Tiryoh commented Dec 24, 2021

全体的な方向性としては良いと思います。細かい表現が一部気になったのでコメントします。

README.mdについて

  • "linux64"についてはDYNAMIXEL SDK固有の表現のようなので"Linux 64bit"と書くのが良いと思います。
  • yaml-cppは0.5.0で大きく変わっているようなので0.5.0以上を必要とすることは書いたほうがいいと思います。
  • RTマニピュレータC++ライブラリのビルド&インストールについて
    • DYNAMIXEL SDKのインストールでは先にcd ~としているのでこちらもgit cloneする前にcd ~したほうがわかりやすいのかなと言う気もします。
      • 1つずつ順番にコピペしてコマンド実行していくと~/DynamixelSDK/c++/build/linux64以下にgit cloneすることになります。

rt_manipulators_lib/README.mdについて

  • "googletestのインストール"はツール名なので"GoogleTestのインストール"の方がいいと思います。

@Tiryoh
Copy link
Contributor

Tiryoh commented Dec 24, 2021

samples/samples01/README.mdについて

-サンプル内にスリープ処理によって通信タイムアウト機能が働き、サーボが脱力します。
+解除しない場合はサンプル実行中にスリープ処理によって通信タイムアウト機能が働き、サーボが脱力します。

@ShotaAk
Copy link
Author

ShotaAk commented Dec 24, 2021

修正しました。

@Tiryoh
Copy link
Contributor

Tiryoh commented Dec 24, 2021

あと細かいですが1箇所だけREADME.mdに修正点です。ほかはOKそうです。

-DYNAMIXEL SDKのe-manual を参考に、linux 64bit環境用にDYNAMIXEL SDKをビルド&インストールします。
+DYNAMIXEL SDKのe-manual を参考に、Linux 64bit環境用にDYNAMIXEL SDKをビルド&インストールします。

@ShotaAk
Copy link
Author

ShotaAk commented Dec 24, 2021

修正しました。

@Tiryoh Tiryoh merged commit 9ffa8d5 into main Dec 24, 2021
@Tiryoh Tiryoh deleted the update_readme branch December 24, 2021 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation only changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants