OSDN Git Service

[change] : Changed documents.
authorhayao <shun819.mail@gmail.com>
Thu, 9 Apr 2020 11:38:06 +0000 (20:38 +0900)
committerhayao <shun819.mail@gmail.com>
Thu, 9 Apr 2020 11:38:06 +0000 (20:38 +0900)
docs/README_jp.md
docs/en/BUILD.md [new file with mode: 0644]
docs/en/PACKAGE.md [moved from docs/jp/PACKAGE.md with 100% similarity]
docs/en/SOFTWARE.md [new file with mode: 0644]
docs/jp/BUILD.md [new file with mode: 0644]
docs/jp/SOFTWARE.md [new file with mode: 0644]

index 1d906e8..16a1ad1 100644 (file)
 
-## Alter Linux - 誰でも使えることを目標にした日本製でArch Linux派生のOS
+<h2 align="center">Alter Linux - 誰でも使えることを目標にした日本製でArch Linux派生のOS</h2>
 
-![AlterLogo](../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png)
+<img src="../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png" alt="AlterLinux logo">
 
-[![License](https://img.shields.io/badge/LICENSE-GPL--3.0-blue?style=for-the-badge&logo=gnu)](../LICENSE)
-[![Base](https://img.shields.io/badge/BASE-ArchLinux-blue?style=for-the-badge&logo=arch-linux)](https://www.archlinux.org/)
-[![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)
-[![Release](https://img.shields.io/github/v/release/SereneTeam/alterlinux?color=blue&include_prereleases&style=for-the-badge)](https://github.com/SereneTeam/alterlinux/releases)
+<a href="../LICENSE"><img src="https://img.shields.io/badge/LICENSE-GPL--3.0-blue?style=for-the-badge&logo=gnu" alt="License: GPLv3.0"></a>
+<a href="https://www.archlinux.org/"><img src="https://img.shields.io/badge/BASE-ArchLinux-blue?style=for-the-badge&logo=arch-linux" alt="Base"></a>
+<a href="https://git.archlinux.org/archiso.git/tag/?h=v43"><img src="https://img.shields.io/badge/archiso--version-43--1-blue?style=for-the-badge&logo=appveyor" alt="archiso-version"></a>
+<a href="https://github.com/SereneTeam/alterlinux/releases"><img src="https://img.shields.io/github/v/release/FascodeNet/alterlinux?color=blue&include_prereleases&style=for-the-badge" alt="release"></a>
 
 | [日本語](README_jp.md) | [English](README.md) |
 |:-----:|:-----:|
 
-## 概要
+<h2 align="center">概要</h2>
 
-Alter LinuxはArch Linuxをベースに開発されている新しいOSです。
-Xfce4による洗練されたUIとGUIで完結するパッケージ管理ツールを兼ね備え、誰でも簡単に高速で最新のOSを使用できます。
-AlterLinuxの最新の状況は[プロジェクトボード](https://github.com/orgs/SereneTeam/projects/2)を確認してください。  
+Alter LinuxはArch Linuxをベースに開発されている新しいOSです。<br>
+AlterLinuxの最新の状況は[プロジェクトボード](https://github.com/orgs/FascodeNet/projects/2)を確認してください。<br>
 
-![Screenshot](../images/screenshot/desktop.png)
+<img src="../images/screenshot/desktop.png" alt="スクリーンショット">
 
-## ブランチ
-主要なブランチは以下のとおりです。これ以外のブランチは一時的なものや特定の用途で使われているものです。
-以前に使用されていたJapaneseブランチは削除されました。
-
-[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)
---- | --- | ---
-最も安定しています。バグの修正などは遅れる場合があります。 | 定期的に更新されます。比較的安定していて、最新の機能や修正を利用できます。 | 常に更新されます。問題が多数残っている場合があります。
-
-## 意見や感想について
-もしAlterLinuxが起動しなかったり、使いにくかったり、標準でインストールしてほしいソフトウェアがあったら、遠慮なく[Issue](https://github.com/SereneTeam/alterlinux/issues)に投稿して下さい。
-私達はAlterLinuxをより良いものにするために様々なユーザーの意見を募集しています。
-
-## Twitter アカウント
-Alter Linuxの最新の状況は随時Twitterで発信しています。時々、今後の方針についてのアンケートなども行っています。
-
-### 公式
-以下は公式のアカウントです。
-- [Alter Linux](https://twitter.com/AlterLinux)
-- [SereneLinux Global](https://twitter.com/SereneLinux)
-- [SereneLinux JP](https://twitter.com/SereneDevJP)
-
-### 開発者
-主な開発メンバーのTwitterへのリンクです。
-このアカウントで行われたすべての発言はSereneTeamの公式ではなく、開発者個人の見解です。
-
-<h5 align="center">開発担当</h5>
-<p align="center">
-<b><a><a href="https://twitter.com/Hayao0819"><img src="https://avatars1.githubusercontent.com/u/32128205" width="100px" /></a></b>
-<b><a><a href="https://twitter.com/Pixel_3a"><img src="https://avatars0.githubusercontent.com/u/48173871" width="100px" /></a></b>
-<b><a><a href="https://twitter.com/yangniao23"><img src="https://avatars0.githubusercontent.com/u/47053316" width="100px" /></a></b>
-<b><a><a href="https://twitter.com/yamad_linuxer"><img src="https://avatars1.githubusercontent.com/u/45691925" width="100px" /></a></b>
-</p>
-
-
-<h5 align="center">デザイン担当</h5>
-<p align="center">
-<b><a><a href="https://twitter.com/tukutuN_27"><img src="https://0e0.pw/5yuH" width="100px" /></a></b>
-</p>
-
-## リポジトリとソフトウェア
-
-### 鍵の追加
-AlterLinuxのリポジトリを使用する場合は鍵を追加する必要が有ります。ビルドの準備を参照して下さい。
-
-### リポジトリ
-以前まで使用されていたGitHubのリポジトリは現在は使用されていません。現在は[こちらのサーバ](https://xn--d-8o2b.com/repo/)が最新のリポジトリです。
-
-
-### ソフトウェア
-ほとんどのパッケージは公式パッケージか、AUR上に公開していますが、一部のものはどちらにもありません。そのようなパッケージのソースコードとPKGBUILDへのリンクを以下に記載します。
-バイナリファイルが必要な場合は[AlterLinuxリポジトリ](https://xn--d-8o2b.com/repo/alter-stable/x86_64/)にアクセスして下さい。
-
-ソースコード | PKGBUILD
---- | ---
- [alterlinux-calamares](https://github.com/SereneTeam/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/stable/alterlinux-calamares)
-[alterlinux-fcitx-conf](https://github.com/SereneTeam/alterlinux-fcitx-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-fcitx-conf)
-[alterlinux-keyring](https://github.com/SereneTeam/alterlinux-keyring) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-keyring)
-[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)
-[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)
-[alterlinux-xfce-conf](https://github.com/SereneTeam/alterlinux-xfce-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-xfce-conf)
-
-
-## ビルド
-
-以下の手順は、実機のArchLinuxでビルドするためのものです。
-
-### 準備
-
-ビルドは実機のArch Linuxを利用する方法とDocker上でビルドする方法があります。
-`build.sh`のオプションは共通です。
-
-```bash
-git clone https://github.com/SereneTeam/alterlinux.git alterlinux
-cd ./alterlinux/
-```
-AlterLinuxには鍵を簡単に追加するスクリプトが含まれています。
 
-```bash
-sudo ./keyring.sh --alter-add
-```
+<h2 align="center">特徴</h2>
+<ul>
+       <li>既に構築されたArchLinux環境をGUIでインストール</li>
+       <li>洗練されたUIやテーマ、アイコンを搭載</li>
+       <li><code>aptpac</code>で<cpde>apt</code>の構文をそのまま使用可能
+       <li>archisoをベースとしたフレームワークにより簡単に派生OSを開発可能</li>
+</ul>
 
-### 実機でビルドする
-実機でビルドする場合はArchLinux環境でビルドする必要があります。  
-ソースコードをダウンロードしてください。
+<h2 align="center">ダウンロード</h2>
+イメージファイルは<a href="https://fascode.net/projects/linux/alter/#downloads">公式サイト</a>からダウンロードできます。
+<br>
+<b>私達はリポジトリやイメージファイル配布のミラーサーバ提供者を探しています。</b>
+<br>
+もし私達にミラーを提供してくださる場合は開発者のTwitterまでお願いします。
 
-```bash
-git clone https://github.com/SereneTeam/alterlinux.git
-cd alterlinux
-```
 
-#### ビルドウィザード
-実機で直接ビルドする場合、wizard.shを使用して簡単に思い通りの設定でビルドできます。bashで書かれていますのでターミナルから実行してください。
-「はい」か「いいえ」の質問は`y`か`n`で応えてください。数値を入力する場合は半角で入力してください。
-
-```bash
-./wizard.sh
-```
-
-#### 手動でオプションを指定してビルドする
-ビルドに必要なパッケージをインストールして下さい。  
-
-```bash
-sudo pacman -S --needed git make arch-install-scripts squashfs-tools libisoburn dosfstools lynx archiso
-```
-オプションは[こちら](#buildsh-options)を参照して下さい。
-
-### コンテナ上でビルドする
-Dockerでビルドする場合は、[この手順](jp/DOCKER.md)を参照してください。
-
-### build.shのオプション
-
-#### 基本
-通常はウィザードを使用してください。
-デフォルトパスワードは`alter`です。
-lymouthは無効化されています。
-デフォルトの圧縮方式は`zstd`です。
-
-```bash
-./build.sh <options> <channel>
-```
-
-#### オプション
-用途 | 使い方
---- | ---
-ブートスプラッシュを有効化 | -b
-カーネルを変える | -k [kernel]
-ユーザ名を変える | -u [username]
-パスワードを変更する | -p [password]
-日本語にする | -j
-圧縮方式を変更する | -c [comp type]
-圧縮のオプションを設定する | -t [comp option]
-出力先ディレクトリを指定する| -o [dir]
-作業ディレクトリを指定する | -w [dir]
-
-
-#### 例
-以下の条件でビルドするにはこのようにします。
-
-- Plymouthを有効化
-- 圧縮方式は`gzip`
-- カーネルは`linux-lqx`
-- パスワードは`ilovearch`
-
-```bash
-./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' xfce
-```
-
-
-#### チャンネルについて
-チャンネルは、インストールするパッケージと含めるファイルを切り替えます。
-この仕組みにより様々なバージョンのAlterLinuxをビルドすることが可能になります。
-2020年3月21日現在でサポートされているチャンネルは以下のとおりです。
-名前 | 目的
---- | ---
-xfce | デスクトップ環境にXfce4を使用し、様々なソフトウェアを追加したデフォルトのチャンネルです。
-plasma | PlasmaとQtアプリを搭載したエディションです。 現在開発中で、安定していません。
-arch | 最小限のGUIとインストーラーのみを搭載し、インストール後は最小限のArchLinuxになります。つまりこれはArchLinuxのインストーラーです。
-
-
-#### カーネルについて
-カーネルは現在、以下の種類がサポートされています。未指定の場合は通常の`linux`カーネルが使用されます。
-`-k`のオプションは必ず`linux-foo`の`foo`の部分を入れてください。例えば`linux-lts`の場合は`lts`が入ります。
-
-以下はサポートされている値とカーネルです。カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。
-
-名前 | 特徴
---- | ---
-ck | linux-ck にはシステムのレスポンスを良くするためのパッチが含まれています。
-lts | coreリポジトリにある長期サポート版 (Long term support, LTS) の Linux カーネルとモジュール。
-lqx | デスクトップ・マルチメディア・ゲーム用途に Debian 用の設定と ZEN カーネルソースを使ってビルドされたディストロカーネル代替
-rt | このパッチを使うことでカーネルのほとんど全てをリアルタイム実行できるようになります。
-zen | linux-zenはカーネルハッカーたちの知恵の結晶です。日常的な利用にうってつけの最高の Linux カーネルになります。
-
-##### 圧縮方式について
-圧縮方式と詳細のオプションは`mksquashfs`のヘルプを参照してください。
-2019年2月12日現在で、`mksquashfs`が対応している方式とオプションは以下の通りです。
+<h2 align="center">ブランチ</h2>
+主要なブランチは以下のとおりです。これ以外のブランチは一時的なものや特定の用途で使われているものです。
 
-```
-gzip
-    -Xcompression-level <compression-level>
-    <compression-level> should be 1 .. 9 (default 9)
-    -Xwindow-size <window-size>
-    <window-size> should be 8 .. 15 (default 15)
-    -Xstrategy strategy1,strategy2,...,strategyN
-    Compress using strategy1,strategy2,...,strategyN in turn
-    and choose the best compression.
-    Available strategies: default, filtered, huffman_only,
-    run_length_encoded and fixed
-lzma (no options)
-lzo
-    -Xalgorithm <algorithm>
-    Where <algorithm> is one of:
-        lzo1x_1
-        lzo1x_1_11
-        lzo1x_1_12
-        lzo1x_1_15
-        lzo1x_999 (default)
-    -Xcompression-level <compression-level>
-    <compression-level> should be 1 .. 9 (default 8)
-    Only applies to lzo1x_999 algorithm
-lz4
-    -Xhc
-    Compress using LZ4 High Compression
-xz
-    -Xbcj filter1,filter2,...,filterN
-    Compress using filter1,filter2,...,filterN in turn
-    (in addition to no filter), and choose the best compression.
-    Available filters: x86, arm, armthumb, powerpc, sparc, ia64
-    -Xdict-size <dict-size>
-    Use <dict-size> as the XZ dictionary size.  The dictionary size
-    can be specified as a percentage of the block size, or as an
-    absolute value.  The dictionary size must be less than or equal
-    to the block size and 8192 bytes or larger.  It must also be
-    storable in the xz header as either 2^n or as 2^n+2^(n+1).
-    Example dict-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K
-    etc.
-zstd
-    -Xcompression-level <compression-level>
-    <compression-level> should be 1 .. 22 (default 15)
-```
+[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)
+--- | --- | ---
+最も安定しています。バグの修正などは遅れる場合があります。 | 定期的に更新されます。比較的安定していて、最新の機能や修正を利用できます。 | 常に更新されます。問題が多数残っている場合があります。
 
-## ドキュメント
-- [チャンネルに関する仕様](jp/CHANNEL.md)
-- [パッケージリストについての注意](jp/PACKAGE.md)
-- [Docker上でビルドする方法](jp/DOCKER.md)
-- [新しいカーネルを追加する方法](jp/KERNEL.md)
 
-## 起動できない場合
\83\96ã\83¼ã\83\88æ\99\82ã\81®ã\82¢ã\83\8bã\83¡ã\83¼ã\82·ã\83§ã\83³ã\82\92ç\84¡å\8a¹å\8c\96ã\81\97ã\81¦ã\83\96ã\83¼ã\83\88ã\81\97ã\80\81ã\83­ã\82°ã\82\92確èª\8dã\81\99ã\82\8bã\81\93ã\81¨ã\81\8cã\81§ã\81\8dã\81¾ã\81\99ã\80\82  
-ディスクから起動し、`Boot Alter Linux without boot splash (x86_64)`を選択して下さい
+<h2 align="center">意見や感想について</h2>
\82\82ã\81\97AlterLinuxã\81\8cèµ·å\8b\95ã\81\97ã\81ªã\81\8bã\81£ã\81\9fã\82\8aã\80\81使ã\81\84ã\81«ã\81\8fã\81\8bã\81£ã\81\9fã\82\8aã\80\81æ¨\99æº\96ã\81§ã\82¤ã\83³ã\82¹ã\83\88ã\83¼ã\83«ã\81\97ã\81¦ã\81»ã\81\97ã\81\84ã\82½ã\83\95ã\83\88ã\82¦ã\82§ã\82¢ã\81\8cã\81\82ã\81£ã\81\9fã\82\89ã\80\81é\81 æ\85®ã\81ªã\81\8f<a href="https://github.com/SereneTeam/alterlinux/issues">Issues</a>ã\81«æ\8a\95稿ã\81\97ã\81¦ä¸\8bã\81\95ã\81\84ã\80\82<br>
+私達はAlterLinuxをより良いものにするために様々なユーザーの意見を募集しています
 
 
-## SereneTeamと開発者について
-SereneTeamは主に中高生で構成されたLinuxディストリビューションの開発チームです。ほぼ全員が日本人で、メンバーは合計で24人います。  
-Ubuntuをベースとした[SereneLinux](https://serenelinux.com)を開発、公開しています。  
-私達はそのノウハウを活かし、Alter Linuxの開発に取り組んでいます。  
+<h2 align="center">ドキュメント</h2>
+一部のドキュメントは情報が古かったり、一部の言語しかない場合が有ります。<br>
+<ul>
+       <li><a href="jp/BUILD.md">AlterLinuxをビルドする</a></li>
+       <li><a href="jp/SOFTWARE.md">独自のパッケージのソースコードについて</a></li>
+       <li><a href="jp/CHANNEL.md">チャンネルに関する仕様</a></li>
+       <li><a href="en/PACKAGE.md">パッケージリストについての注意</a></li>
+       <li><a href="jp/DOCKER.md">Docker上でビルドする方法</a></li>
+       <li><a href="jp/KERNEL.md">新しいカーネルを追加する方法</a></li>
+</ul>
+
+
+<h2 align="center">起動できない場合</h2>
+ブート時のアニメーションを無効化してブートし、ログを確認することができます。<br>
+ディスクから起動し、<code>Boot Alter Linux without boot splash (x86_64)</code>を選択して下さい。<br>
+また、発生した状況や機種名などを<a href="https://github.com/FascodeNet/alterlinux/issues">こちら</a>に書いて開発者に報告して下さい。
+
+
+<h2 align="center">FascodeNetworkと開発者について</h2>
+<a href="https://fascode.net/">Fascode Network</a>は学生を主体とする創作チームです。<br>
+<a href="https://fascode.net/projects/linux/alter/">AlterLinux</a>と<a href="https://fascode.net/projects/linux/serene/">SereneLinux</a>の開発を行っています。
+
+<h3 align="center">公式Twitterアカウント</h3>
+<a href="https://twitter.com/FascodeNetwork">
+       <img src="https://pbs.twimg.com/profile_images/1245716817831530497/JEkKX1XN_400x400.jpg" width="100px">
+</a>
+<a href="https://twitter.com/Fascode_JP">
+       <img src="https://pbs.twimg.com/profile_images/1245682659231068160/Nn5tPUvB_400x400.jpg" width="100px">
+</a>
+
+<h3 align="center">開発者Twitterアカウント</h3>
+<a href="https://twitter.com/Hayao0819">
+       <img src="https://avatars1.githubusercontent.com/u/32128205" width="100px">
+</a>
+<a href="https://twitter.com/Pixel_3a">
+       <img src="https://avatars0.githubusercontent.com/u/48173871" width="100px">
+</a>
+<a href="https://twitter.com/YangDevJP">
+       <img src="https://avatars0.githubusercontent.com/u/47053316" width="100px">
+</a>
+<a href="https://twitter.com/yamad_linuxer">
+       <img src="https://avatars1.githubusercontent.com/u/45691925" width="100px">
+</a>
+<a href="https://twitter.com/tukutuN_27">
+       <img src="https://0e0.pw/5yuH" width="100px">
+</a>
+<a href="https://twitter.com/naoko1010hh">
+       <img src="https://avatars1.githubusercontent.com/u/50263013" width="100px">
+</a>
diff --git a/docs/en/BUILD.md b/docs/en/BUILD.md
new file mode 100644 (file)
index 0000000..6835c35
--- /dev/null
@@ -0,0 +1,149 @@
+## Build
+
+The following procedure is for building with the actual machine ArchLinux.
+
+### Preparation
+
+There are two ways to build, using Arch Linux on the actual machine and building on Docker.
+The options of `build.sh` are common.
+
+```bash
+git clone https://github.com/SereneTeam/alterlinux.git alterlinux
+cd ./alterlinux/
+```
+AlterLinux includes a script to easily add keys.
+
+```bash
+sudo ./keyring.sh --alter-add
+```
+
+#### Build on real machine
+When building with an actual machine, it is necessary to build in an ArchLinux environment.  
+Install the necessary packages for the build.
+
+```bash
+sudo pacman -S --needed git make arch-install-scripts squashfs-tools libisoburn dosfstools lynx archiso
+```
+Then download the source code.
+
+```bash
+git clone https://github.com/SereneTeam/alterlinux.git
+cd alterlinux
+./build.sh
+```
+
+
+#### Build on container
+If you build on Docker, please refer to [this procedure](en/DOCKER.md).
+
+### build.sh options
+
+#### Basic
+Please execute as it is.
+The default password is `alter`.
+Plymouth has been disabled.
+Default compression type is `zstd`.
+
+
+#### Options
+ Purpose | Usage
+--- | ---
+ Enable boot splash | -b
+ Change kernel | -k [kernel]
+ Change the username | -u [username]
+ Change the password | -p [password]
+ Japanese | -j
+ Change compression method | -c [comp type]
+ Set compression options | -t [comp option]
+ Specify output destination directory | -o [dir]
+ Specify working directory | -w [dir]
+
+
+##### Example
+
+To build under the following conditions:
+
+- Enable Plymouth
+- The compression method is `gzip`
+- The kernel is `linux-lqx`
+- The password is `ilovearch`
+
+```bash
+./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' stable
+```
+
+
+#### Channel
+Channels switch between packages to install and files to include.
+This mechanism allows you to build various versions of AlterLinux.
+The supported channels as of March 21, 2020 are:
+
+Name | Purpose
+--- | ---
+xfce | This is the default channel that uses Xfce4 for the desktop environment and adds various software.
+plasma | This is an edition with Plasma and Qt apps. Currently in development and not stable.
+arch | It has only a minimal GUI and installer, and after installation it has a minimal ArchLinux. This is an ArchLinux installer.
+
+
+#### About the kernel
+The following types of kernels are currently supported: If unspecified, the normal `linux` kernel will be used.
+Make sure to include the `foo` part of` linux-foo` in the `-k` option. For example, `linux-lts` contains` lts`.
+  
+Below are the supported values and kernels.The description of the kernel is from [ArchWiki](https://wiki.archlinux.org/index.php/Kernel).
+
+Name | Feature
+--- | ---
+ck | linux-ck contains patches to improve system response.
+lts |Long term support (LTS) Linux kernel and modules from the core repository.
+lqx | Distro kernel alternative built using Debian configuration and ZEN kernel source for desktop multimedia games.
+rt | With this patch, almost all of the kernel can be run in real time.
+zen | linux-zen is the wisdom of kernel hackers. It is the best Linux kernel for everyday use.
+
+
+##### About compression type
+See the `mksquashfs` help for compression options and more options.
+As of February 12, 2019, `mksquashfs` supports the following methods and options.
+
+```
+gzip
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 9 (default 9)
+    -Xwindow-size <window-size>
+    <window-size> should be 8 .. 15 (default 15)
+    -Xstrategy strategy1,strategy2,...,strategyN
+    Compress using strategy1,strategy2,...,strategyN in turn
+    and choose the best compression.
+    Available strategies: default, filtered, huffman_only,
+    run_length_encoded and fixed
+lzma (no options)
+lzo
+    -Xalgorithm <algorithm>
+    Where <algorithm> is one of:
+        lzo1x_1
+        lzo1x_1_11
+        lzo1x_1_12
+        lzo1x_1_15
+        lzo1x_999 (default)
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 9 (default 8)
+    Only applies to lzo1x_999 algorithm
+lz4
+    -Xhc
+    Compress using LZ4 High Compression
+xz
+    -Xbcj filter1,filter2,...,filterN
+    Compress using filter1,filter2,...,filterN in turn
+    (in addition to no filter), and choose the best compression.
+    Available filters: x86, arm, armthumb, powerpc, sparc, ia64
+    -Xdict-size <dict-size>
+    Use <dict-size> as the XZ dictionary size.  The dictionary size
+    can be specified as a percentage of the block size, or as an
+    absolute value.  The dictionary size must be less than or equal
+    to the block size and 8192 bytes or larger.  It must also be
+    storable in the xz header as either 2^n or as 2^n+2^(n+1).
+    Example dict-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K
+    etc.
+zstd
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 22 (default 15)
+```
\ No newline at end of file
similarity index 100%
rename from docs/jp/PACKAGE.md
rename to docs/en/PACKAGE.md
diff --git a/docs/en/SOFTWARE.md b/docs/en/SOFTWARE.md
new file mode 100644 (file)
index 0000000..087ca49
--- /dev/null
@@ -0,0 +1,19 @@
+## Repositories and software
+If you use the AlterLinux repository, you need to add a key. See Preparing for a build.
+
+### Repositories
+GitHub repositories that were used before are no longer used. Currently [this server](https://xn--d-8o2b.com/repo/) is the latest repository.
+
+
+### Software
+Most packages are official packages or published on the AUR, but some are not in either. The source code of such packages and links to PKGBUILD are listed below.
+If you need a binary file, access [the AlterLinux repository](https://xn--d-8o2b.com/repo/alter-stable/x86_64/).
+
+Source code | PKGBUILD
+--- | ---
+ [alterlinux-calamares](https://github.com/SereneTeam/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/stable/alterlinux-calamares)
+[alterlinux-fcitx-conf](https://github.com/SereneTeam/alterlinux-fcitx-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-fcitx-conf)
+[alterlinux-keyring](https://github.com/SereneTeam/alterlinux-keyring) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-keyring)
+[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)
+[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)
+[alterlinux-xfce-conf](https://github.com/SereneTeam/alterlinux-xfce-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-xfce-conf)
\ No newline at end of file
diff --git a/docs/jp/BUILD.md b/docs/jp/BUILD.md
new file mode 100644 (file)
index 0000000..d6a8245
--- /dev/null
@@ -0,0 +1,158 @@
+## AlterLinuxをビルドする
+
+以下の手順は、実機のArchLinuxでビルドするためのものです。
+
+### 準備
+
+ビルドは実機のArch Linuxを利用する方法とDocker上でビルドする方法があります。
+`build.sh`のオプションは共通です。
+
+```bash
+git clone https://github.com/SereneTeam/alterlinux.git alterlinux
+cd ./alterlinux/
+```
+AlterLinuxには鍵を簡単に追加するスクリプトが含まれています。
+
+```bash
+sudo ./keyring.sh --alter-add
+```
+
+### 実機でビルドする
+実機でビルドする場合はArchLinux環境でビルドする必要があります。  
+ソースコードをダウンロードしてください。
+
+```bash
+git clone https://github.com/SereneTeam/alterlinux.git
+cd alterlinux
+```
+
+#### ビルドウィザード
+実機で直接ビルドする場合、wizard.shを使用して簡単に思い通りの設定でビルドできます。bashで書かれていますのでターミナルから実行してください。
+「はい」か「いいえ」の質問は`y`か`n`で応えてください。数値を入力する場合は半角で入力してください。
+
+```bash
+./wizard.sh
+```
+
+#### 手動でオプションを指定してビルドする
+ビルドに必要なパッケージをインストールして下さい。  
+
+```bash
+sudo pacman -S --needed git make arch-install-scripts squashfs-tools libisoburn dosfstools lynx archiso
+```
+オプションは[こちら](#buildsh-options)を参照して下さい。
+
+### コンテナ上でビルドする
+Dockerでビルドする場合は、[この手順](jp/DOCKER.md)を参照してください。
+
+### build.shのオプション
+
+#### 基本
+通常はウィザードを使用してください。
+デフォルトパスワードは`alter`です。
+lymouthは無効化されています。
+デフォルトの圧縮方式は`zstd`です。
+
+```bash
+./build.sh <options> <channel>
+```
+
+#### オプション
+用途 | 使い方
+--- | ---
+ブートスプラッシュを有効化 | -b
+カーネルを変える | -k [kernel]
+ユーザ名を変える | -u [username]
+パスワードを変更する | -p [password]
+日本語にする | -j
+圧縮方式を変更する | -c [comp type]
+圧縮のオプションを設定する | -t [comp option]
+出力先ディレクトリを指定する| -o [dir]
+作業ディレクトリを指定する | -w [dir]
+
+
+#### 例
+以下の条件でビルドするにはこのようにします。
+
+- Plymouthを有効化
+- 圧縮方式は`gzip`
+- カーネルは`linux-lqx`
+- パスワードは`ilovearch`
+
+```bash
+./build.sh -b -c "gzip" -k "lqx" -p 'ilovearch' xfce
+```
+
+
+#### チャンネルについて
+チャンネルは、インストールするパッケージと含めるファイルを切り替えます。
+この仕組みにより様々なバージョンのAlterLinuxをビルドすることが可能になります。
+2020年3月21日現在でサポートされているチャンネルは以下のとおりです。
+名前 | 目的
+--- | ---
+xfce | デスクトップ環境にXfce4を使用し、様々なソフトウェアを追加したデフォルトのチャンネルです。
+plasma | PlasmaとQtアプリを搭載したエディションです。 現在開発中で、安定していません。
+arch | 最小限のGUIとインストーラーのみを搭載し、インストール後は最小限のArchLinuxになります。つまりこれはArchLinuxのインストーラーです。
+
+
+#### カーネルについて
+カーネルは現在、以下の種類がサポートされています。未指定の場合は通常の`linux`カーネルが使用されます。
+`-k`のオプションは必ず`linux-foo`の`foo`の部分を入れてください。例えば`linux-lts`の場合は`lts`が入ります。
+
+以下はサポートされている値とカーネルです。カーネルの説明は[ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB)を引用しています。
+
+名前 | 特徴
+--- | ---
+ck | linux-ck にはシステムのレスポンスを良くするためのパッチが含まれています。
+lts | coreリポジトリにある長期サポート版 (Long term support, LTS) の Linux カーネルとモジュール。
+lqx | デスクトップ・マルチメディア・ゲーム用途に Debian 用の設定と ZEN カーネルソースを使ってビルドされたディストロカーネル代替
+rt | このパッチを使うことでカーネルのほとんど全てをリアルタイム実行できるようになります。
+zen | linux-zenはカーネルハッカーたちの知恵の結晶です。日常的な利用にうってつけの最高の Linux カーネルになります。
+
+##### 圧縮方式について
+圧縮方式と詳細のオプションは`mksquashfs`のヘルプを参照してください。
+2019年2月12日現在で、`mksquashfs`が対応している方式とオプションは以下の通りです。
+
+```
+gzip
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 9 (default 9)
+    -Xwindow-size <window-size>
+    <window-size> should be 8 .. 15 (default 15)
+    -Xstrategy strategy1,strategy2,...,strategyN
+    Compress using strategy1,strategy2,...,strategyN in turn
+    and choose the best compression.
+    Available strategies: default, filtered, huffman_only,
+    run_length_encoded and fixed
+lzma (no options)
+lzo
+    -Xalgorithm <algorithm>
+    Where <algorithm> is one of:
+        lzo1x_1
+        lzo1x_1_11
+        lzo1x_1_12
+        lzo1x_1_15
+        lzo1x_999 (default)
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 9 (default 8)
+    Only applies to lzo1x_999 algorithm
+lz4
+    -Xhc
+    Compress using LZ4 High Compression
+xz
+    -Xbcj filter1,filter2,...,filterN
+    Compress using filter1,filter2,...,filterN in turn
+    (in addition to no filter), and choose the best compression.
+    Available filters: x86, arm, armthumb, powerpc, sparc, ia64
+    -Xdict-size <dict-size>
+    Use <dict-size> as the XZ dictionary size.  The dictionary size
+    can be specified as a percentage of the block size, or as an
+    absolute value.  The dictionary size must be less than or equal
+    to the block size and 8192 bytes or larger.  It must also be
+    storable in the xz header as either 2^n or as 2^n+2^(n+1).
+    Example dict-sizes are 75%, 50%, 37.5%, 25%, or 32K, 16K, 8K
+    etc.
+zstd
+    -Xcompression-level <compression-level>
+    <compression-level> should be 1 .. 22 (default 15)
+```
\ No newline at end of file
diff --git a/docs/jp/SOFTWARE.md b/docs/jp/SOFTWARE.md
new file mode 100644 (file)
index 0000000..ecf1ff6
--- /dev/null
@@ -0,0 +1,21 @@
+## リポジトリとソフトウェア
+
+### 鍵の追加
+AlterLinuxのリポジトリを使用する場合は鍵を追加する必要が有ります。ビルドの準備を参照して下さい。
+
+### リポジトリ
+以前まで使用されていたGitHubのリポジトリは現在は使用されていません。現在は[こちらのサーバ](https://xn--d-8o2b.com/repo/)が最新のリポジトリです。
+
+
+### ソフトウェア
+ほとんどのパッケージは公式パッケージか、AUR上に公開していますが、一部のものはどちらにもありません。そのようなパッケージのソースコードとPKGBUILDへのリンクを以下に記載します。
+バイナリファイルが必要な場合は[AlterLinuxリポジトリ](https://xn--d-8o2b.com/repo/alter-stable/x86_64/)にアクセスして下さい。
+
+ソースコード | PKGBUILD
+--- | ---
+ [alterlinux-calamares](https://github.com/SereneTeam/alterlinux-calamares) | [PKGBUILD](https://github.com/FascodeNet/alterlinux-pkgbuilds/tree/master/stable/alterlinux-calamares)
+[alterlinux-fcitx-conf](https://github.com/SereneTeam/alterlinux-fcitx-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-fcitx-conf)
+[alterlinux-keyring](https://github.com/SereneTeam/alterlinux-keyring) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-keyring)
+[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)
+[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)
+[alterlinux-xfce-conf](https://github.com/SereneTeam/alterlinux-xfce-conf) | [PKGBUILD](https://github.com/SereneTeam/alterlinux-pkgbuilds/tree/master/stable/alterlinux-xfce-conf)
\ No newline at end of file