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

Add explanations about the device files to README #56

Merged
merged 7 commits into from
Jun 23, 2020
Merged

Conversation

ShotaAk
Copy link
Contributor

@ShotaAk ShotaAk commented Jun 23, 2020

Checklists

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

What does this implement/fix? Explain your changes.

  • READMEにデバイスファイルの説明を追記しました
  • Installationの説明に英文を追記しました。

Does this close any currently open issues?

関連: #40

@ShotaAk ShotaAk added the Type: Documentation Documentation only changes label Jun 23, 2020
@Tiryoh Tiryoh linked an issue Jun 23, 2020 that may be closed by this pull request
@Tiryoh Tiryoh self-requested a review June 23, 2020 01:56
@Tiryoh Tiryoh self-assigned this Jun 23, 2020
### arm64版Ubuntu18.04
### for arm64 Ubuntu18.04

Add a following new line in `/boot/firmware/config.txt` to change the i2c_baudrate to 62.5 kHz.
Copy link
Contributor

Choose a reason for hiding this comment

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

It may be necessary to set the I2C baudrate lower than the default value (issues#13).

みたいな1行がほしいです。(下げなくても動く場合があるらしいので)

@@ -81,7 +91,118 @@ Raspberry Pi 4で本ドライバを使用する際には`rtmouse.c`の以下の
#define RASPBERRYPI 2
```

### その他
## Device files
Copy link
Contributor

Choose a reason for hiding this comment

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

デバイスファイルはアルファベット順にソートするか、Input/Outputでまとめると見やすいかなと思いました。

README.md Outdated Show resolved Hide resolved
@Tiryoh Tiryoh self-requested a review June 23, 2020 04:48
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.

lgtm

@Tiryoh Tiryoh changed the title Add explanations of the device files in README Add explanations about the device files to README Jun 23, 2020
@Tiryoh Tiryoh merged commit c28a065 into master Jun 23, 2020
@Tiryoh Tiryoh deleted the update_readme branch June 23, 2020 07:32
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.

各デバイスファイルについての説明をREADMEに入れる
2 participants