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

Create README.md #28

Merged
merged 3 commits into from
Feb 12, 2020
Merged

Create README.md #28

merged 3 commits into from
Feb 12, 2020

Conversation

ShotaAk
Copy link
Contributor

@ShotaAk ShotaAk commented Feb 4, 2020

SampleProgramディレクトリにREADMEを追加しました。


各機能ごとにShell Script、C、Pythonで書かれたサンプルコードを用意しています。

Each peripheral example have sample code files written Shell Script, C and Python.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Each peripheral example have/Each peripheral example has/
だと思います。

# Step3

スイッチを押してLEDを点消灯します。
組み合わせは次のとおりです
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/次のとおりです/次のとおりです。/
ほかが句読点を含んでいるので統一したらいいと思います。

Copy link
Contributor

@Tiryoh Tiryoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Type [Ctrl-c] to terminate.など「Type [key]」という表記が複数見られますが、Press [Ctrl-c] to terminate.など「Press [key]」の方がわかりやすいのではないかと思います。
type [Ctrl-c]と言われると、"C", "t", "r", "l"...と入力していくようなイメージがあります。

実際に「type ctrl c」などでググると「press ctrl c」がヒットしますし、以下のリポジトリではpressが使用されているので、typeよりはpressの方がよい気がします。
https://github.com/vim-ctrlspace/vim-ctrlspace

これについてはコードの変更も含むので、別issueを立てます。

@ShotaAk
Copy link
Contributor Author

ShotaAk commented Feb 7, 2020

Type [Ctrl-c] to terminate.など「Type [key]」という表記が複数見られますが、Press [Ctrl-c] to terminate.など「Press [key]」の方がわかりやすいのではないかと思います。
type [Ctrl-c]と言われると、"C", "t", "r", "l"...と入力していくようなイメージがあります。

実際に「type ctrl c」などでググると「press ctrl c」がヒットしますし、以下のリポジトリではpressが使用されているので、typeよりはpressの方がよい気がします。
https://github.com/vim-ctrlspace/vim-ctrlspace

これについてはコードの変更も含むので、別issueを立てます。

ありがとうございます。TypeとPressの使い分けを理解しました。
issue立てもありがとうございます。

@ShotaAk
Copy link
Contributor Author

ShotaAk commented Feb 7, 2020

修正しました。

Copy link
Contributor

@Tiryoh Tiryoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

先ほどは最後の方いくつか読み飛ばしてしまっていたので追記しました

'c'を入力するとプログラムが終了します。(Shell ScriptではCtrl-cで終了します。)

Beep the buzzer with keyboard input.
Refer the [./SCALE](./SCALE) file for the pairs of input characters and scales.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Refer the/Refer to the/
だと思います。

組み合わせは次のとおりです。

Turn on/off LEDs by the switches.
The pairs of LEDs and switches are bellow:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The combination of LEDs and switches are defined as below.
とかどうでしょうか。

@ShotaAk
Copy link
Contributor Author

ShotaAk commented Feb 7, 2020

修正しました

@Tiryoh Tiryoh added the Type: Documentation Documentation only changes label Feb 12, 2020
@ShotaAk ShotaAk merged commit 61b1913 into master Feb 12, 2020
@Tiryoh Tiryoh deleted the add-readme branch February 20, 2020 04:11
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