mirror of
https://github.com/brain-hackers/wiki.brainux.org
synced 2024-11-14 14:18:03 +09:00
Merge branch 'master' into remove-ruby-dependent
This commit is contained in:
Codex340
GitHub
commit
1ea6c3a377
2
.github/CODEOWNERS
vendored
Normal file
2
.github/CODEOWNERS
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
/_pages @Sasakura-ayato @Codex340
|
||||
/_posts @Sasakura-ayato @Codex340
|
||||
@ -31,15 +31,22 @@ Linux ディストリビューションは、カーネルとそれ以外のソ
|
||||
|
||||
|機種 |Linux 起動 |キーボード |注釈|
|
||||
|:-----|:----------------:|:----------------:|:---|
|
||||
|PW-Sx1 より前|||PW-GC610, PW-G5300 のような数字が3桁もしくは4桁の機種|
|
||||
|PW-ACxxx, GCxxx, TC980||||
|
||||
|PW-G4000, G5000, G5100, A7000, A9000||||
|
||||
|PW-G4200, G5200 ~ 5300, A7200 ~ 7400, A9100 ~ 9300|:white_check_mark:|:white_check_mark:||
|
||||
|GX500, GX300|:white_check_mark:|:white_check_mark:|画面が非常に暗くなる|
|
||||
|PW-Sx1|:white_check_mark:|:white_check_mark:||
|
||||
|PW-Sx2|:white_check_mark:|:white_check_mark:||
|
||||
|PW-Sx3|:white_check_mark:| ||
|
||||
|PW-Sx3|:white_check_mark:|:white_check_mark:||
|
||||
|PW-Sx4|:white_check_mark:| ||
|
||||
|PW-Sx5|:white_check_mark:| ||
|
||||
|PW-Sx6|:white_check_mark:| ||
|
||||
|PW-Sx7|:white_check_mark:| |未リリース・Sx6 を流用可|
|
||||
|PW-x1 以降||||
|
||||
|PW-Sx5|:white_check_mark:|:white_check_mark:||
|
||||
|PW-Sx6|:white_check_mark:|:white_check_mark:||
|
||||
|PW-Sx7|:white_check_mark:|:white_check_mark:||
|
||||
|PW-HC4 ~ 6, H7700 ~ H9100|:white_check_mark:|:white_check_mark:||
|
||||
|PW-SR1 ~ 3|:white_check_mark:|:white_check_mark:||
|
||||
|PW-AA1 ~ 2|:white_check_mark:|:white_check_mark:||
|
||||
|PW-AJ1 ~ 2|:white_check_mark:|:white_check_mark:||
|
||||
|PW-x1, x2, ESxxxx, SR4||||
|
||||
|
||||
|
||||
# SD カードのイメージをダウンロードする
|
||||
@ -128,9 +135,28 @@ sudo dd if=~/Downloads/sdimage-2021-02-21-162410.img of=/dev/sdc bs=10M
|
||||
|
||||
# 実機で起動する
|
||||
|
||||
書き込み終わった SD カードを Brain に挿入して Linux を起動しましょう。起動には2つの方法があり、カバーできる機種と動作に差があります。
|
||||
|
||||
- SDカードからの直接起動
|
||||
- BrainLILO を通じた起動
|
||||
|
||||
|
||||
## SDカードからの直接起動
|
||||
|
||||
書き込み終わった SD カードを Brain に挿入し、リセットボタンを押します。Brain のロゴが表示されたあと U-Boot が起動し、すぐ後に Linux が起動します。
|
||||
|
||||
本体の内蔵キーボードに対応している機種では、ログインシェルが表示されたらユーザー名とパスワードともに `root` でログインできます。非対応の機種では、電源供給が可能なタイプの OTG ケーブルを使用してキーボードをつなぐと操作できます。
|
||||
|
||||
## BrainLILO を通じた起動
|
||||
|
||||
上記の直接起動にはいくつか問題があります。これらを回避したい場合は、Windows CE 起動後に "Launch Linux" を追加アプリメニューから選択して Linux を起動します。
|
||||
|
||||
- クロック周波数が半減する（修正予定）
|
||||
- 直接起動ができない機種を使っている: PW-G4200, G5200, A7200, A7300, A9200, GX300, GX500
|
||||
|
||||
|
||||
# ログイン
|
||||
|
||||
本体の内蔵キーボードに対応している機種では、ログインシェルが表示されたらユーザー名 `user` パスワード `brain` でログインできます。非対応の機種では、電源供給が可能なタイプの OTG ケーブルを使用してキーボードをつなぐと操作できます。root ユーザーは無効になっているのでご注意ください。
|
||||
|
||||
|
||||
# 内蔵ハードウェア
|
||||
@ -138,15 +164,51 @@ sudo dd if=~/Downloads/sdimage-2021-02-21-162410.img of=/dev/sdc bs=10M
|
||||
Brain における Linux の動作はまだ初期段階であり、一部のハードウェアしか利用できません。
|
||||
|
||||
|
||||
## キーボード (Sx1, Sx2)
|
||||
## キーボード
|
||||
|
||||
キーが非常に少ない Brain のキーボードで必要な記号を打つため、キーボードの使用方法は特殊になっています。キートップに記載されたキー以外の文字は、すべて「記号」キーと「シフト」キーを組み合わせて入力します。
|
||||
|
||||
Shift キー・Ctrl キー・Alt キーは現実のキーボードに近い配置として以下のように対応させています。
|
||||
Shift キー・Ctrl キー・Alt キーは現実のキーボードに近い配置で対応させています。古い機種は Space キーがないため「Sジャンプ」キーに割り当てています。
|
||||
|
||||
- Shift → 「シフト」
|
||||
- Ctrl → ページアップキー（《 を横に倒した記号のキー）
|
||||
- Alt → 「文字切り替え」キー
|
||||
|
||||
### Gxxxx, Axxxx の場合
|
||||
|
||||
|特殊キー|対応するキー|備考|
|
||||
|:-:|:-:|:-:|
|
||||
|Shift|機能||
|
||||
|Ctrl|音声||
|
||||
|Alt|前見出||
|
||||
|Space|Sジャンプ||
|
||||
|
||||
|
||||
### Sx1 ~ Sx3, HC4 ~ HC6, SR1 の場合
|
||||
|
||||
|特殊キー|対応するキー|備考|
|
||||
|:-:|:-:|:-:|
|
||||
|Shift|シフト||
|
||||
|Ctrl|ページアップ|`《` を横に倒した記号|
|
||||
|Alt|文字切り替え||
|
||||
|
||||
|
||||
### Sx4, H7700, SR2 の場合
|
||||
|
||||
|特殊キー|対応するキー|備考|
|
||||
|:-:|:-:|:-:|
|
||||
|Shift|シフト||
|
||||
|Ctrl|音声||
|
||||
|Alt|ページアップ|`《` を横に倒した記号|
|
||||
|
||||
|
||||
### Sx5 ~ Sx7, H7800 ~ H9100, AAx, AJx, SR3 の場合
|
||||
|
||||
|特殊キー|対応するキー|備考|
|
||||
|:-:|:-:|:-:|
|
||||
|Shift|シフト||
|
||||
|Ctrl|ページアップ|`《` を横に倒した記号|
|
||||
|Alt|音声||
|
||||
|
||||
|
||||
## キーマップ
|
||||
|
||||
キーと入力される文字のマップを以下に示します。
|
||||
|
||||
|
||||
@ -5,41 +5,11 @@ categories:
|
||||
tags:
|
||||
- Linux
|
||||
- GUI
|
||||
excerpt: Brain 特有の Xorg の設定について
|
||||
excerpt: Xorg について
|
||||
---
|
||||
|
||||
|
||||
# Brain 特有の Xorg の設定について
|
||||
# GUI の利用方法
|
||||
|
||||
PW-Sx7 までは SoC に GPU が載っておらず、framebuffer (fbdev) のみが利用可能です。つまり、お手元の Linux マシンで Xorg が GPU と通信するときに使うしくみ (DRM, DRI) は利用できません。設定ファイルに fbdev を使用するよう明示的に書くことで Xorg が動かせます。
|
||||
|
||||
|
||||
# xorg.conf
|
||||
|
||||
設定ファイル xorg.conf の内容を以下に示します。vi か nano を使って以下の内容を `/etc/X11/xorg.conf` に書き込んでください。
|
||||
|
||||
<!-- markdownlint-disable fenced-code-language -->
|
||||
```
|
||||
Section "Device"
|
||||
Identifier "device"
|
||||
Driver "fbdev"
|
||||
EndSection
|
||||
Section "Screen"
|
||||
Identifier "screen"
|
||||
Device "device"
|
||||
EndSection
|
||||
```
|
||||
<!-- markdownlint-enable fenced-code-language -->
|
||||
|
||||
|
||||
# 起こし方
|
||||
|
||||
2021年2月23日現在では、Xorg はブートシークエンスと結合されていません。つまり、手で起動します。
|
||||
|
||||
```sh
|
||||
$ Xorg &
|
||||
$ openbox-session &
|
||||
```
|
||||
|
||||
以上を実行した後にお好みのソフトを起動してください。
|
||||
Brainux バージョン 2021-03-22-233911 以降は Xorg と jwm が標準でインストールされています。ログイン画面にて jwm 等の好きな DE を選びログインしてください。
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ excerpt: ""
|
||||
|
||||
# 準備
|
||||
|
||||
GitHubにログインした状態でWikiをcloneします。
|
||||
GitHub にログインした状態で Wiki を clone します。
|
||||
|
||||
```sh
|
||||
$ git clone git@github.com:brain-hackers/wiki.brainux.org.git
|
||||
@ -32,10 +32,12 @@ ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux-gnu]
|
||||
```
|
||||
|
||||
次に手元でのビルドに必要な依存関係をインストールします。
|
||||
インストールには Bundler を用います。Bundler は gem を使ってインストールしてください。
|
||||
|
||||
|
||||
```sh
|
||||
$ cd wiki.brainux.org
|
||||
$ sudo gem install bundler
|
||||
$ bundle install
|
||||
```
|
||||
|
||||
@ -58,14 +60,16 @@ Configuration file: /Users/takumi/dev/brain/wiki.brainux.org/_config.yml
|
||||
Server running... press ctrl-c to stop.
|
||||
````
|
||||
|
||||
次に、Textlintとmarkdownlintを使うためにNode.jsとパッケージをインストールします。
|
||||
次に、textlint と markdownlint を使うために Node.js とパッケージをインストールします。
|
||||
|
||||
```sh
|
||||
$ cd wiki.brainux.org
|
||||
$ npm install
|
||||
```
|
||||
|
||||
Node.jsのインストール方法とバージョンは動けば何でも良いです。まずはパッケージマネージャーでインストールしたNode.jsを使ってみて、うまく行かなければnodeenv（nodenvではない！）を使う以下の方法を試してください。nodeenvでインストールした場合は、毎回envをactivateするのを忘れないでください。
|
||||
Node.js のインストールの方法は問いませんが、不具合を減らすために、LTS を利用することをお勧めします。なお、2022年5月12日現在の LTS バージョンは [v16](https://nodejs.org/en/about/releases/) です。
|
||||
|
||||
また、Node.js のバージョン管理の1つの選択肢として、nodeenv を利用することも可能です。nodeenv を利用する場合は、毎回 env を activate することを忘れないでください。以下に、nodeenv を pip でインストールし、利用する例を示します。
|
||||
|
||||
```sh
|
||||
$ pip install nodeenv
|
||||
@ -74,14 +78,14 @@ $ source ./env/bin/activate
|
||||
(env) $ npm install
|
||||
```
|
||||
|
||||
Textlintを動かして、正常にlintされるか試します。`npm run textlint-fix`で発動する自動修正は、誤検知も意図せず修正してしまう可能性があるため事前によくチェックしてから実行してください。
|
||||
textlint を動かして、正常に lint されるか試します。`npm run textlint-fix` で発動する自動修正は、誤検知も意図せず修正してしまう可能性があるため事前によくチェックしてから実行してください。
|
||||
|
||||
```sh
|
||||
$ npm run textlint
|
||||
$ npm run textlint-fix # お好みで
|
||||
```
|
||||
|
||||
markdownlintを動かして、正常にlintされるか試します。
|
||||
markdownlint を動かして、正常に lint されるか試します。
|
||||
|
||||
```sh
|
||||
$ npm run mdlint
|
||||
@ -98,32 +102,34 @@ $ npm run mdlint
|
||||
- `_posts` ディレクトリにあるほかのファイルを参考にして md ファイルを追加します
|
||||
- 例: `2038-1-19-doomsday.md`
|
||||
- 記事内容を記述します
|
||||
- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します
|
||||
- `npm run textlint` と `npm run mdlint` を実行し、エラーが出ないことを確認します
|
||||
- もし誤検知があった場合はルールを修正するかレビュアーと相談してください
|
||||
- エラー箇所をどうしても押し通したい場合はそこだけlintを無効化するよう記述してレビュアーに説明してください
|
||||
- エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください
|
||||
- 一通り追加と削除が終わったら `pull -r`, commit, push します
|
||||
|
||||
|
||||
## 1. b. ページを編集する
|
||||
|
||||
- 記事内容を記述します
|
||||
- `npm textlint` と `npm mdlint` を実行し、エラーが出ないことを確認します
|
||||
- `npm run textlint` と `npm run mdlint` を実行し、エラーが出ないことを確認します
|
||||
- もし誤検知があった場合はルールを修正するかレビュアーと相談してください
|
||||
- エラー箇所をどうしても押し通したい場合はそこだけlintを無効化するよう記述してレビュアーに説明してください
|
||||
- エラー箇所をどうしても押し通したい場合はそこだけ lint を無効化するよう記述してレビュアーに説明してください
|
||||
- 一通り編集が終わったら `pull -r`, commit, push します
|
||||
|
||||
|
||||
## 2. 変更を提出する・レビューを受ける・マージしてもらう
|
||||
|
||||
文章に対するどのような変更も、必ずPull Requestを提出してドキュメント編集権限のあるメンバー最低1人にレビューを依頼します。
|
||||
このレビューに通ると変更がマージされ、公開されます。PRのタイトルや文章は丁寧に記述しましょう。詳細はScrapboxの[超説明・開発フロー](https://scrapbox.io/brain-hackers/%E8%B6%85%E8%AA%AC%E6%98%8E%E3%83%BB%E9%96%8B%E7%99%BA%E3%83%95%E3%83%AD%E3%83%BC)を参照してください。
|
||||
文章に対するどのような変更も、必ず Pull Request (PR) を提出してドキュメント編集権限のあるメンバー最低1人にレビューを依頼します。
|
||||
このレビューに通ると変更がマージされ、公開されます。PR のタイトルや文章は丁寧に記述しましょう。詳細は Scrapbox の[超説明・開発フロー](https://scrapbox.io/brain-hackers/%E8%B6%85%E8%AA%AC%E6%98%8E%E3%83%BB%E9%96%8B%E7%99%BA%E3%83%95%E3%83%AD%E3%83%BC)を参照してください。
|
||||
|
||||
2021年12月現在、編集権限のあるメンバーは以下の通りです。
|
||||
2022年5月現在、編集権限のあるメンバーは以下の通りです。
|
||||
|
||||
- @puhitaku
|
||||
- @tka3320
|
||||
- @Sasakura-ayato
|
||||
- @Codex340
|
||||
|
||||
注意！GitHub の Brain Hackers organization のメンバーでない人はレビューを依頼できないので、
|
||||
注意！ GitHub の Brain Hackers organization のメンバーでない人はレビューを依頼できないので、
|
||||
Discord にてメンバー追加依頼をしてメンバーになってから Pull Request を提出しましょう。
|
||||
|
||||
|
||||
@ -137,31 +143,31 @@ Wiki のページを生成している Jekyll は、md ファイルの名前か
|
||||
|
||||
# 記述ルール
|
||||
|
||||
Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールはTextlintやmarkdownlintを使って機械的に調べたり修正できます。
|
||||
Wiki の体裁に関するルールを列挙します。コミットの前に従っているかチェックしてください。一部のルールは textlint や markdownlint を使って機械的に調べたり修正できます。
|
||||
|
||||
|
||||
## 文体
|
||||
|
||||
基本的には、技術文書のルールと同一です。助詞の使いすぎや表記ゆれはtextlintでチェックできますが、機械的に検知できる範囲は限られているためよく心得ておいてください。
|
||||
基本的には、技術文書のルールと同一です。助詞の使いすぎや表記ゆれは textlint でチェックできますが、機械的に検知できる範囲は限られているためよく心得ておいてください。
|
||||
|
||||
|
||||
### 「ですます」と「だ・である」は統一する
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
Wiki 全体で「ですます」の形で統一します。
|
||||
|
||||
|
||||
### 依頼する時はできるだけ「します」で締める
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
「〇〇してください」は長いので、「します」で極力統一します。不自然に映る場合は「してください」や「しましょう」を使っても OK です。この文書でも実際にどちらも使用しています。
|
||||
|
||||
|
||||
### 繰り返しや冗長な表現をなくす
|
||||
|
||||
Linterによるチェック: textlint（部分的）
|
||||
Linter によるチェック: textlint（部分的）
|
||||
|
||||
冗長な表現を組み込んでしまうことは多いので、極限まで削ります。
|
||||
「など」「いろいろ」「といった」「〇〇できます」は使いがちですので特に気を付けましょう。
|
||||
@ -173,7 +179,7 @@ Linterによるチェック: textlint（部分的）
|
||||
|
||||
### 括弧は基本的に使わない
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
どうしても必要な場合は、名詞の別名や補足といった1〜2単語で済む体言を入れるだけにします。
|
||||
|
||||
@ -184,14 +190,14 @@ Linterによるチェック: **なし**
|
||||
|
||||
### 箇条書きには句読点を入れない
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
箇条書きは段落を表現する道具ではありません。よって、内容が極力短くなるようにしつつ、句読点を置かないようにします。
|
||||
|
||||
|
||||
### 感情を排除する
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
極力スムーズに読める文章になるには、感情的表現を取り除く事が必須です。
|
||||
文章は技術文書（レポート）のような無味乾燥なものにし、感情は Discord で共有しましょう。
|
||||
@ -199,7 +205,7 @@ Linterによるチェック: **なし**
|
||||
|
||||
### コードブロックや画像と文章の関わりを示す
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
「以下にコマンド例を示します」などのように、文章と以下に連なる要素を関連付けます。
|
||||
|
||||
@ -207,7 +213,7 @@ Linterによるチェック: **なし**
|
||||
## Markdown
|
||||
|
||||
Markdown はリッチなレンダリングがなくとも読めるシンタックスが特徴です。これを念頭に置いて、以下のルールに従ってください。
|
||||
一部はmarkdownlintによって違反を検知できます。ここにない細かなルールはmarkdownlintの指示に従ってください。
|
||||
一部は markdownlint によって違反を検知できます。ここにない細かなルールは markdownlint の指示に従ってください。
|
||||
|
||||
|
||||
### 必ずプレビューして確認する
|
||||
@ -232,7 +238,7 @@ git config --global core.autocrlf input
|
||||
|
||||
### 適切な空行を入れる
|
||||
|
||||
Linterによるチェック: あり
|
||||
Linter によるチェック: あり
|
||||
|
||||
以下の箇所には1行空行を入れます。
|
||||
|
||||
@ -252,9 +258,9 @@ Linterによるチェック: あり
|
||||
|
||||
### 適切な空白を入れる
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
プレーンテキスト以外の要素の前後には適切な空白を入れ、表示がおかしくなるリスクを減らしましょう。この文書はWikiでの表示に限られるため空白を欠いても大丈夫ですが、エディタでのシンタックスハイライトに失敗することがありますので気を付けましょう。
|
||||
プレーンテキスト以外の要素の前後には適切な空白を入れ、表示がおかしくなるリスクを減らしましょう。この文書は Wiki での表示に限られるため空白を欠いても大丈夫ですが、エディタでのシンタックスハイライトに失敗することがありますので気を付けましょう。
|
||||
|
||||
:x: 悪い例1: `1.あいうえお`
|
||||
|
||||
@ -267,7 +273,7 @@ Linterによるチェック: **なし**
|
||||
|
||||
### コードスパンとコードブロックを使い分ける
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
コードスパンとは、`` `ident` ``のように行の中に等幅で文字を入れるスパン要素を指します。
|
||||
|
||||
@ -292,7 +298,7 @@ ls -l
|
||||
|
||||
### 明示的改行はバックスラッシュで行う
|
||||
|
||||
Linterによるチェック: **なし**
|
||||
Linter によるチェック: **なし**
|
||||
|
||||
この節でいう明示的改行とは Hard line breaks のことで、空行による段落区切りや単一の LF による Soft line break ではなく確実に改行を入れることを指します。必要でない限りは使わないことが望ましいです。
|
||||
|
||||
|
||||
@ -1696,13 +1696,6 @@ rules:
|
||||
pattern: /アノーテーション/
|
||||
- expected: アプレット
|
||||
pattern: /\bApplet\b/
|
||||
- expected: アプリケーション
|
||||
pattern: /アプリ(?!ケ)/
|
||||
specs:
|
||||
- from: アプリケーション
|
||||
to: アプリケーション
|
||||
- from: アプリ
|
||||
to: アプリケーション
|
||||
- expected: アンダースコア
|
||||
pattern: /アンダーバー/
|
||||
- expected: イシュア
|
||||
|
||||
Loading…
Reference in New Issue
Block a user