- 関数内でしか使用しない変数は必ず`local`で宣言する
- コマンド置き換えは`` `echo hoge` ``ではなく`$(echo hoge)`を使用する
- 算術式展開は`$(( m + n ))`を使用する
+- ローカル変数、関数は名前を`_`から始める
### if、for、test、case、while
+
- `test`コマンドは必ず`[[`を使用する
- `do`や`then`などは`while`、`for`、`if`と同じ行に書く
- `case`の際はなるべくインデントを揃える
- Declare variables that are used only in the function by `local`
- Command substitution does not use a `` `echo hoge` `` but uses `$(echo hoge)`
- Arithmetic expansion uses `$(( m + n ))`
+- Local variables, functions start their names with `_`
### if, for, test, case, while
+
- The `test` command must use `[[`
- `do`, `then`, etc. write on the same line as `while`, `for` and `if`
- Align indents on `cases` as much as possible
<h2>Alter Linux - Arch Linux-derived OS made in Japan aimed at anyone to use</h2>
<p align="center">
- <img src="../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png" alt="Alter Linux logo">
+ <img src="../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png" alt="Alter Linux logo">
</p>
<p align="center">
- <a href="https://fascode.net/en/projects/linux/alter/">
- <img src="https://img.shields.io/badge/Maintained%3F-Yes-green?style=for-the-badge">
- </a>
- <a href="../LICENSE">
- <img src="https://img.shields.io/github/license/FascodeNet/alterlinux?style=for-the-badge" 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://gitlab.archlinux.org/archlinux/archiso/-/tree/v46">
- <img src="https://img.shields.io/badge/archiso--version-46--1-blue?style=for-the-badge&logo=arch-linux" alt="archiso-version">
- </a>
+ <a href="https://fascode.net/en/projects/linux/alter/">
+ <img src="https://img.shields.io/badge/Maintained%3F-Yes-green?style=for-the-badge">
+ </a>
+ <a href="../LICENSE">
+ <img src="https://img.shields.io/github/license/FascodeNet/alterlinux?style=for-the-badge" 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://gitlab.archlinux.org/archlinux/archiso/-/tree/v46">
+ <img src="https://img.shields.io/badge/archiso--version-46--1-blue?style=for-the-badge&logo=arch-linux" alt="archiso-version">
+ </a>
</p>
<p align="center">
- <a href="https://travis-ci.com/github/FascodeNet/alterlinux">
- <img src="https://img.shields.io/travis/com/FascodeNet/alterlinux?style=for-the-badge">
- </a>
- <a href="https://github.com/FascodeNet/alterlinux/issues">
- <img src="https://img.shields.io/github/issues/FascodeNet/alterlinux?color=violet&style=for-the-badge&logo=github" alt="Issues">
- </a>
- <a href="https://github.com/FascodeNet/alterlinux/stargazers">
- <img src="https://img.shields.io/github/stars/FascodeNet/alterlinux?color=yellow&style=for-the-badge&logo=github">
- </a>
- <a href="https://github.com/FascodeNet/alterlinux/network/members">
- <img src="https://img.shields.io/github/forks/FascodeNet/alterlinux?style=for-the-badge">
- </a>
+ <a href="https://travis-ci.com/github/FascodeNet/alterlinux">
+ <img src="https://img.shields.io/travis/com/FascodeNet/alterlinux?style=for-the-badge">
+ </a>
+ <a href="https://github.com/FascodeNet/alterlinux/issues">
+ <img src="https://img.shields.io/github/issues/FascodeNet/alterlinux?color=violet&style=for-the-badge&logo=github" alt="Issues">
+ </a>
+ <a href="https://github.com/FascodeNet/alterlinux/stargazers">
+ <img src="https://img.shields.io/github/stars/FascodeNet/alterlinux?color=yellow&style=for-the-badge&logo=github">
+ </a>
+ <a href="https://github.com/FascodeNet/alterlinux/network/members">
+ <img src="https://img.shields.io/github/forks/FascodeNet/alterlinux?style=for-the-badge">
+ </a>
</p>
<p align="center">
- <a href="https://github.com/FascodeNet/alterlinux/releases">
- <img src="https://img.shields.io/github/v/release/FascodeNet/alterlinux?color=blue&include_prereleases&style=for-the-badge" alt="release">
- </a>
- <a href="https://fascode.net/en/projects/linux/alter/downloads/">
- <img src="https://img.shields.io/github/downloads/FascodeNet/alterlinux/total?style=for-the-badge">
- </a>
- <a href="">
- <img src="https://img.shields.io/github/last-commit/FascodeNet/alterlinux?style=for-the-badge">
- </a>
+ <a href="https://github.com/FascodeNet/alterlinux/releases">
+ <img src="https://img.shields.io/github/v/release/FascodeNet/alterlinux?color=blue&include_prereleases&style=for-the-badge" alt="release">
+ </a>
+ <a href="https://fascode.net/en/projects/linux/alter/downloads/">
+ <img src="https://img.shields.io/github/downloads/FascodeNet/alterlinux/total?style=for-the-badge">
+ </a>
+ <a href="https://github.com/FascodeNet/alterlinux/commits/">
+ <img src="https://img.shields.io/github/last-commit/FascodeNet/alterlinux?style=for-the-badge">
+ </a>
</p>
<table>
All documentation can be found in <code>docs</code>.<br>
If you find a typographical error or a notation that isn't the case, please report it on Issues.<br>
<ul>
- <li><a href="en/BUILD.md">Build Alter Linux</a></li>
- <li><a href="en/SOFTWARE.md">About the source code of your own package</a></li>
- <li><a href="en/CHANNEL.md">Channel specifications</a></li>
- <li><a href="en/PACKAGE.md">Notes on package list</a></li>
- <li><a href="en/DOCKER.md">How to build on Docker</a></li>
- <li><a href="en/KERNEL.md">How to add a new kernel</a></li>
- <li><a href="en/CONFIG.md">About build configuration file</a></li>
+ <li><a href="en/BUILD.md">Build Alter Linux</a></li>
+ <li><a href="en/SOFTWARE.md">About the source code of your own package</a></li>
+ <li><a href="en/CHANNEL.md">Channel specifications</a></li>
+ <li><a href="en/PACKAGE.md">Notes on package list</a></li>
+ <li><a href="en/DOCKER.md">How to build on Docker</a></li>
+ <li><a href="en/KERNEL.md">How to add a new kernel</a></li>
+ <li><a href="en/CONFIG.md">About build configuration file</a></li>
+ <li><a href="en/arch-pkgbuild-parser.md">About arch-pkgbuild-parser</a></li>
</ul>
-
<h2>〈If you cannot start〉</h2>
You can disable the boot animation and boot to see the logs.<br>
Boot from the disk and select <code>Boot Alter Linux without boot splash (x86_64)</code>.<br>
```bash
./build.sh <options> <channel>
- ```
+ ```
#### option
+
Run `./build.sh -h` for full options and usage.
-| 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] |
+ Purpose | Usage
+--- | ---
+ Enable boot splash | -b
+ Change kernel | -k [kernel]
+ Change the username | -u [username]
+ Change the password | -p [password]
+ Japanese | -l ja
+ Change compression method | -c [comp type]
+ Set compression options | -t [comp option]
+ Specify output destination directory | -o [dir]
+ Specify working directory | -w [dir]
##### Note
+
All options described after the channel name are ignored. Be sure to put the option before the channel name.
#### An example
The following channels are supported as of August 17, 2020.
See `./build.sh -h` for a complete list of channels.
-| Name | Purpose |
-| -------- | ----------------------------------------------------------- |
-| cinnamon | Gorgeous cinnamon desktop with many applications. |
-| gnome | This channel does not have a description.txt. |
-| i3 | using i3, a dynamic tiling window manager inspired by wmii. |
-| lxde | Composed of Lxde and a little software |
-| plasma | Uses KDE and Qt software. |
-| releng | Build ArchLinux as is. Boot splash etc. cannot be used. |
-| xfce | Use Xfce4 for desktop environment. |
-| rebuild | Rebuild using the settings of the previous build. |
+Name | Purpose
+--- | ---
+basic | Base channel for configuring channels
+cinnamon | Gorgeous cinnamon desktop with many applications.
+gnome | Gnome customized with extension and software for beginner
+i3 | using i3, a dynamic tiling window manager inspired by wmii.
+lxde | Composed of Lxde and a little software
+plasma | Uses KDE and Qt software.
+releng | Build ArchLinux as is. Boot splash etc. cannot be used.
+xfce | Use Xfce4 for desktop environment.
+xfce-pro | Pro Edition with some software added to Xfce and replaced with Compiz
+rebuild | Build from the point where it left off using the previous build settings.
-
-
#### About the kernel
+
Both the `i686` architecture and the` x86_64` architecture support the official ArchLinux kernels `linux`,` linux-lts`, and `linux-zen`.
In addition to the official kernel, `x86_64` also supports the following kernels.
The description of the kernel is taken from the [ArchWiki](https://wiki.archlinux.jp/index.php/%E3%82%AB%E3%83%BC%E3%83%8D%E3%83%AB).