OSDN Git Service

[fix] : Fixed link.
[alterlinux/alterlinux.git] / docs / README_jp.md
1
2 ## Alter Linux - 誰でも使えることを目標にした日本製でArch Linux派生のOS
3
4 ![AlterLogo](../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png)
5
6 [![License](https://img.shields.io/badge/LICENSE-GPL--3.0-blue?style=for-the-badge&logo=gnu)](../LICENSE)
7 [![Base](https://img.shields.io/badge/BASE-ArchLinux-blue?style=for-the-badge&logo=arch-linux)](https://www.archlinux.org/)
8 [![archiso](https://img.shields.io/badge/archiso--version-43--1-blue?style=for-the-badge&logo=appveyor)](https://git.archlinux.org/archiso.git/tag/?h=v43)
9 [![Release](https://img.shields.io/github/v/release/SereneTeam/alterlinux?color=blue&include_prereleases&style=for-the-badge)](https://github.com/SereneTeam/alterlinux/releases)
10
11 | [日本語](README_jp.md) | [English](README.md) |
12 |:-----:|:-----:|
13
14 ## 概要
15
16 Alter LinuxはArch Linuxをベースに開発されている新しいOSです。
17 Xfce4による洗練されたUIとGUIで完結するパッケージ管理ツールを兼ね備え、誰でも簡単に高速で最新のOSを使用できます。
18 AlterLinuxの最新の状況は[プロジェクトボード](https://github.com/orgs/SereneTeam/projects/2)を確認してください。  
19
20 ![Screenshot](../images/screenshot/desktop.png)
21
22 ## ブランチ
23 主要なブランチは以下のとおりです。これ以外のブランチは一時的なものや特定の用途で使われているものです。
24 以前に使用されていたJapaneseブランチは削除されました。
25
26 [master](https://github.com/SereneTeam/alterlinux/tree/master) | [dev-stable](https://github.com/SereneTeam/alterlinux/tree/dev-stable) | [dev](https://github.com/SereneTeam/alterlinux/tree/dev)
27 --- | --- | ---
28 最も安定しています。バグの修正などは遅れる場合があります。 | 定期的に更新されます。比較的安定していて、最新の機能や修正を利用できます。 | 常に更新されます。問題が多数残っている場合があります。
29
30 ## 意見や感想について
31 もしAlterLinuxが起動しなかったり、使いにくかったり、標準でインストールしてほしいソフトウェアがあったら、遠慮なく[Issue](https://github.com/SereneTeam/alterlinux/issues)に投稿して下さい。
32 私達はAlterLinuxをより良いものにするために様々なユーザーの意見を募集しています。
33
34 ## Twitter アカウント
35 Alter Linuxの最新の状況は随時Twitterで発信しています。時々、今後の方針についてのアンケートなども行っています。
36
37 ### 公式
38 以下は公式のアカウントです。
39 - [Alter Linux](https://twitter.com/AlterLinux)
40 - [SereneLinux Global](https://twitter.com/SereneLinux)
41 - [SereneLinux JP](https://twitter.com/SereneDevJP)
42
43 ### 開発者
44 主な開発メンバーのTwitterへのリンクです。
45 このアカウントで行われたすべての発言はSereneTeamの公式ではなく、開発者個人の見解です。
46
47 <h5 align="center">開発担当</h5>
48 <p align="center">
49 <b><a><a href="https://twitter.com/Hayao0819"><img src="https://avatars1.githubusercontent.com/u/32128205" width="100px" /></a></b>
50 <b><a><a href="https://twitter.com/Pixel_3a"><img src="https://avatars0.githubusercontent.com/u/48173871" width="100px" /></a></b>
51 <b><a><a href="https://twitter.com/yangniao23"><img src="https://avatars0.githubusercontent.com/u/47053316" width="100px" /></a></b>
52 <b><a><a href="https://twitter.com/yamad_linuxer"><img src="https://avatars1.githubusercontent.com/u/45691925" width="100px" /></a></b>
53 </p>
54
55
56 <h5 align="center">デザイン担当</h5>
57 <p align="center">
58 <b><a><a href="https://twitter.com/tukutuN_27"><img src="https://0e0.pw/5yuH" width="100px" /></a></b>
59 </p>
60
61 ## リポジトリとソフトウェア
62
63 ### 鍵の追加
64 AlterLinuxのリポジトリを使用する場合は鍵を追加する必要が有ります。ビルドの準備を参照して下さい。
65
66 ### リポジトリ
67 以前まで使用されていたGitHubのリポジトリは現在は使用されていません。現在は[こちらのサーバ](https://xn--d-8o2b.com/repo/)が最新のリポジトリです。
68
69
70 ### ソフトウェア
71 ほとんどのパッケージは公式パッケージか、AUR上に公開していますが、一部のものはどちらにもありません。そのようなパッケージのソースコードとPKGBUILDへのリンクを以下に記載します。
72 バイナリファイルが必要な場合は[AlterLinuxリポジトリ](https://xn--d-8o2b.com/repo/alter-stable/x86_64/)にアクセスして下さい。
73
74 ソースコード | PKGBUILD
75 --- | ---
76  [alterlinux-calamares](https://github.com/SereneTeam/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/stable/alterlinux-calamares)
77 [alterlinux-fcitx-conf](https://github.com/SereneTeam/alterlinux-fcitx-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-fcitx-conf)
78 [alterlinux-keyring](https://github.com/SereneTeam/alterlinux-keyring) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-keyring)
79 [alterlinux-mirrorlist](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-mirrorlist) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-mirrorlist)
80 [alterlinux-wallpapers](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-wallpapers) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-wallpapers)
81 [alterlinux-xfce-conf](https://github.com/SereneTeam/alterlinux-xfce-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-xfce-conf)
82
83
84 ## ビルド
85
86 以下の手順は、実機のArchLinuxでビルドするためのものです。
87
88 ### 準備
89
90 ビルドは実機のArch Linuxを利用する方法とDocker上でビルドする方法があります。
91 `build.sh`のオプションは共通です。
92
93 ```bash
94 git clone https://github.com/SereneTeam/alterlinux.git alterlinux
95 cd ./alterlinux/
96 ```
97 AlterLinuxには鍵を簡単に追加するスクリプトが含まれています。
98
99 ```bash
100 sudo ./add-key.sh --alter
101 ```
102
103 ### 実機でビルドする
104 実機でビルドする場合はArchLinux環境でビルドする必要があります。  
105 ソースコードをダウンロードしてください。
106
107 ```bash
108 git clone https://github.com/SereneTeam/alterlinux.git
109 cd alterlinux
110 ```
111
112 #### ビルドウィザード
113 実機で直接ビルドする場合、wizard.shを使用して簡単に思い通りの設定でビルドできます。bashで書かれていますのでターミナルから実行してください。
114 「はい」か「いいえ」の質問は`y`か`n`で応えてください。数値を入力する場合は半角で入力してください。
115
116 ```bash
117 ./wizard.sh
118 ```
119
120 #### 手動でオプションを指定してビルドする
121 ビルドに必要なパッケージをインストールして下さい。  
122
123 ```bash
124 sudo pacman -S --needed git make arch-install-scripts squashfs-tools libisoburn dosfstools lynx archiso
125 ```
126 オプションは[こちら](#buildsh-options)を参照して下さい。
127
128 ### コンテナ上でビルドする
129 Dockerでビルドする場合は、[この手順](jp/DOCKER.md)を参照してください。
130
131 ### build.shのオプション
132
133 #### 基本
134 通常はウィザードを使用してください。
135 デフォルトパスワードは`alter`です。
136 lymouthは無効化されています。
137 デフォルトの圧縮方式は`zstd`です。
138
139 ```bash
140 ./build.sh <options> <channel>
141 ```
142
143 #### オプション
144 用途 | 使い方
145 --- | ---
146 ブートスプラッシュを有効化 | -b
147 カーネルを変える | -k [kernel]
148 ユーザ名を変える | -u [username]
149 パスワードを変更する | -p [password]
150 日本語にする | -j
151 圧縮方式を変更する | -c [comp type]
152 圧縮のオプションを設定する | -t [comp option]
153 出力先ディレクトリを指定する| -o [dir]
154 作業ディレクトリを指定する | -w [dir]
155
156
157 #### 例
158 以下の条件でビルドするにはこのようにします。
159
160 - Plymouthを有効化
161 - 圧縮方式は`gzip`
162 - カーネルは`linux-lqx`
163 - パスワードは`ilovearch`
164
165 ```bash
166 ./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' xfce
167 ```
168
169
170 #### チャンネルについて
171 チャンネルは、インストールするパッケージと含めるファイルを切り替えます。
172 この仕組みにより様々なバージョンのAlterLinuxをビルドすることが可能になります。
173 2020年3月21日現在でサポートされているチャンネルは以下のとおりです。
174 名前 | 目的
175 --- | ---
176 xfce | デスクトップ環境にXfce4を使用し、様々なソフトウェアを追加したデフォルトのチャンネルです。
177 plasma | PlasmaとQtアプリを搭載したエディションです。 現在開発中で、安定していません。
178 arch | 最小限のGUIとインストーラーのみを搭載し、インストール後は最小限のArchLinuxになります。つまりこれはArchLinuxのインストーラーです。
179
180
181 #### カーネルについて
182 カーネルは現在、以下の種類がサポートされています。未指定の場合は通常の`linux`カーネルが使用されます。
183 `-k`のオプションは必ず`linux-foo`の`foo`の部分を入れてください。例えば`linux-lts`の場合は`lts`が入ります。
184
185 以下はサポートされている値とカーネルです。カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。
186
187 名前 | 特徴
188 --- | ---
189 ck | linux-ck にはシステムのレスポンスを良くするためのパッチが含まれています。
190 lts | coreリポジトリにある長期サポート版 (Long term support, LTS) の Linux カーネルとモジュール。
191 lqx | デスクトップ・マルチメディア・ゲーム用途に Debian 用の設定と ZEN カーネルソースを使ってビルドされたディストロカーネル代替
192 rt | このパッチを使うことでカーネルのほとんど全てをリアルタイム実行できるようになります。
193 zen | linux-zenはカーネルハッカーたちの知恵の結晶です。日常的な利用にうってつけの最高の Linux カーネルになります。
194
195 ##### 圧縮方式について
196 圧縮方式と詳細のオプションは`mksquashfs`のヘルプを参照してください。
197 2019年2月12日現在で、`mksquashfs`が対応している方式とオプションは以下の通りです。
198
199 ```
200 gzip
201     -Xcompression-level <compression-level>
202     <compression-level> should be 1 .. 9 (default 9)
203     -Xwindow-size <window-size>
204     <window-size> should be 8 .. 15 (default 15)
205     -Xstrategy strategy1,strategy2,...,strategyN
206     Compress using strategy1,strategy2,...,strategyN in turn
207     and choose the best compression.
208     Available strategies: default, filtered, huffman_only,
209     run_length_encoded and fixed
210 lzma (no options)
211 lzo
212     -Xalgorithm <algorithm>
213     Where <algorithm> is one of:
214         lzo1x_1
215         lzo1x_1_11
216         lzo1x_1_12
217         lzo1x_1_15
218         lzo1x_999 (default)
219     -Xcompression-level <compression-level>
220     <compression-level> should be 1 .. 9 (default 8)
221     Only applies to lzo1x_999 algorithm
222 lz4
223     -Xhc
224     Compress using LZ4 High Compression
225 xz
226     -Xbcj filter1,filter2,...,filterN
227     Compress using filter1,filter2,...,filterN in turn
228     (in addition to no filter), and choose the best compression.
229     Available filters: x86, arm, armthumb, powerpc, sparc, ia64
230     -Xdict-size <dict-size>
231     Use <dict-size> as the XZ dictionary size.  The dictionary size
232     can be specified as a percentage of the block size, or as an
233     absolute value.  The dictionary size must be less than or equal
234     to the block size and 8192 bytes or larger.  It must also be
235     storable in the xz header as either 2^n or as 2^n+2^(n+1).
236     Example dict-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K
237     etc.
238 zstd
239     -Xcompression-level <compression-level>
240     <compression-level> should be 1 .. 22 (default 15)
241 ```
242
243 ## ドキュメント
244 - [チャンネルに関する仕様](jp/CHANNEL.md)
245 - [パッケージリストについての注意](jp/PACKAGE.md)
246 - [Docker上でビルドする方法](jp/DOCKER.md)
247 - [新しいカーネルを追加する方法](jp/KERNEL.md)
248
249 ## 起動できない場合
250 ブート時のアニメーションを無効化してブートし、ログを確認することができます。  
251 ディスクから起動し、`Boot Alter Linux without boot splash (x86_64)`を選択して下さい。
252
253
254 ## SereneTeamと開発者について
255 SereneTeamは主に中高生で構成されたLinuxディストリビューションの開発チームです。ほぼ全員が日本人で、メンバーは合計で24人います。  
256 Ubuntuをベースとした[SereneLinux](https://serenelinux.com)を開発、公開しています。  
257 私達はそのノウハウを活かし、Alter Linuxの開発に取り組んでいます。