docs/README.md

   1 <h2>Alter Linux - Arch Linux-derived OS made in Japan aimed at anyone to use</h2>
   2
   3 <p align="center">
   4     <img src="../images/logo/color-black-catchcopy/AlterV6-LogowithCopy-Colored-DarkText-256px.png" alt="Alter Linux logo">
   5 </p>
   6 <p align="center">
   7     <a href="https://fascode.net/en/projects/linux/alter/">
   8         <img src="https://img.shields.io/badge/Maintained%3F-Yes-green?style=for-the-badge">
   9     </a>
  10     <a href="../LICENSE">
  11         <img src="https://img.shields.io/github/license/FascodeNet/alterlinux?style=for-the-badge" alt="License: GPLv3.0">
  12     </a>
  13     <a href="https://www.archlinux.org/">
  14         <img src="https://img.shields.io/badge/BASE-ArchLinux-blue?style=for-the-badge&logo=arch-linux" alt="Base">
  15     </a>
  16     <a href="https://gitlab.archlinux.org/archlinux/archiso/-/tree/v48">
  17         <img src="https://img.shields.io/badge/archiso--version-48--1-blue?style=for-the-badge&logo=arch-linux" alt="archiso-version">
  18     </a>
  19 </p>
  20 <p align="center">
  21         <a href="https://travis-ci.com/github/FascodeNet/alterlinux">
  22                 <img src="https://img.shields.io/travis/com/FascodeNet/alterlinux?style=for-the-badge">
  23         </a>
  24         <a href="https://github.com/FascodeNet/alterlinux/issues">
  25                 <img src="https://img.shields.io/github/issues/FascodeNet/alterlinux?color=violet&style=for-the-badge&logo=github" alt="Issues">
  26         </a>
  27         <a href="https://github.com/FascodeNet/alterlinux/stargazers">
  28                 <img src="https://img.shields.io/github/stars/FascodeNet/alterlinux?color=yellow&style=for-the-badge&logo=github">
  29         </a>
  30         <a href="https://github.com/FascodeNet/alterlinux/network/members">
  31                 <img src="https://img.shields.io/github/forks/FascodeNet/alterlinux?style=for-the-badge">
  32         </a>
  33 </p>
  34 <p align="center">
  35         <a href="https://github.com/FascodeNet/alterlinux/releases">
  36                 <img src="https://img.shields.io/github/v/release/FascodeNet/alterlinux?color=blue&include_prereleases&style=for-the-badge" alt="release">
  37         </a>
  38         <a href="https://fascode.net/en/projects/linux/alter/downloads/">
  39                 <img src="https://img.shields.io/github/downloads/FascodeNet/alterlinux/total?style=for-the-badge">
  40         </a>
  41         <a href="https://github.com/FascodeNet/alterlinux/commits/">
  42                 <img src="https://img.shields.io/github/last-commit/FascodeNet/alterlinux?style=for-the-badge">
  43         </a>
  44 </p>
  45
  46 <table>
  47     <thead>
  48         <tr>
  49             <th style="text-align:center">
  50                 <a href="README_jp.md">日本語</a>
  51             </th>
  52             <th style="text-align:center">
  53                 <a href="README.md">English</a>
  54             </th>
  55         </tr>
  56     </thead>
  57 </table>
  58
  59 <b>
  60     日本語版は<a href="README_jp.md">こちら</a>にあります
  61 </b>
  62
  63 <h2>〈Overview〉</h2>
  64
  65 Alter Linux is a new OS developed based on Arch Linux.<br>
  66 Check the <a href="https://github.com/orgs/FascodeNet/projects/2">project board</a> for the latest status of Alter Linux.<br>
  67 Please see the <a href="https://fascode.net/projects/linux/alter/">official website</a> for information on announcements and bugs for users.
  68
  69 <h3>Xfce</h3>
  70 <img src="../images/screenshot/desktop-xfce.png" alt="screenshot">
  71
  72 <h3>Lxde</h3>
  73 <img src="../images/screenshot/desktop-lxde.png" alt="screenshot">
  74
  75 <h3>Gnome</h3>
  76 <img src="../images/screenshot/desktop-gnome.png" alt="screenshot">
  77
  78 <h3>Cinnamon</h3>
  79 <img src="../images/screenshot/desktop-cinnamon.png" alt="screenshot">
  80
  81 <h3>i3wm</h3>
  82 <img src="../images/screenshot/desktop-i3wm.png" alt="screenshot">
  83
  84 <h2>〈Feature〉</h2>
  85 <ul>
  86     <li>You can install the already built Arch Linux environment with GUI</li>
  87     <li>We release not only 64bit but also 32bit version.</li>
  88     <li>The 32-bit version does not require PAE (Physical Address Extension).</li>
  89     <li>Adopt ZEN kernel by default</li>
  90     <li>Equipped with sophisticated UI, themes, and icons</li>
  91     <li>You can use the syntax of <code>apt</code> with <code>aptpac</code></li>
  92     <li>Easy development of derived OS by framework based on archiso</li>
  93 </ul>
  94
  95 <h2>〈Download〉</h2>
  96 The image file can be downloaded from the official <a href="https://fascode.net/projects/linux/alter/#downloads">website</a>.
  97 <br>
  98 <b>We are looking for a mirror server provider for repositories and image file distribution.</b>
  99 <br>
 100 If you would like us to provide a mirror please contact the developer's Twitter.
 101
 102 <h2>〈Branch〉</h2>
 103 These are a list of major branches. Other branches are temporary or used for specific purposes.
 104
 105 <table>
 106     <thead>
 107         <tr>
 108             <th>
 109                 <a href="https://github.com/FascodeNet/alterlinux/tree/master">master</a>
 110             </th>
 111             <th>
 112                 <a href="https://github.com/FascodeNet/alterlinux/tree/stable">stable</a>
 113             </th>
 114             <th>
 115                 <a href="https://github.com/FascodeNet/alterlinux/tree/dev-stable">dev-stable</a>
 116             </th>
 117             <th>
 118                 <a href="https://github.com/FascodeNet/alterlinux/tree/dev">dev</a>
 119             </th>
 120         </tr>
 121     </thead>
 122     <tbody>
 123         <tr>
 124             <td>
 125                 Most stable. Bug fixes may be delayed.
 126             </td>
 127             <td>
 128                 Release candidate. Most bugs have been fixed.
 129             </td>
 130             <td>
 131                 It is updated regularly. Relatively stable, with the latest features and fixes. *
 132             </td>
 133             <td>
 134                 Always updated. There may be many issues left.
 135             </td>
 136         </tr>
 137     </tbody>
 138 </table>
 139
 140 <h2>〈About opinion and impression〉</h2>
 141 If Alter Linux doesn't start, is hard to use, or has any software you want installed by default, feel free to post it to <a href="https://github.com/FascodeNet/alterlinux/issues">Issues</a>.<br>
 142 We are soliciting opinions from various users to make Alter Linux better.<br>
 143
 144 <h2>〈When submitting a bug report or pull request〉</h2>
 145 Be sure to read <a href="CONTRIBUTING.md">CONTRIBUTING.md</a>.
 146
 147 <h2>〈Documents〉</h2>
 148 Some documents may have outdated information or only some languages.<br>
 149 All documentation can be found in <code>docs</code>.<br>
 150 If you find a typographical error or a notation that isn't the case, please report it on Issues.<br>
 151 <ul>
 152         <li><a href="en/BUILD.md">Build Alter Linux</a></li>
 153         <li><a href="en/SOFTWARE.md">About the source code of your own package</a></li>
 154         <li><a href="en/CHANNEL.md">Channel specifications</a></li>
 155         <li><a href="en/PACKAGE.md">Notes on package list</a></li>
 156         <li><a href="en/DOCKER.md">How to build on Docker</a></li>
 157         <li><a href="en/KERNEL.md">How to add a new kernel</a></li>
 158         <li><a href="en/CONFIG.md">About build configuration file</a></li>
 159 </ul>
 160
 161 <h2>〈If you cannot start〉</h2>
 162 You can disable the boot animation and boot to see the logs.<br>
 163 Boot from the disk and select <code>Boot Alter Linux without boot splash (x86_64)</code>.<br>
 164 In addition, please write down the situation and model name <a href="https://github.com/FascodeNet/alterlinux/issues">here</a>, and report it to the developer.
 165
 166 <h2>〈About FascodeNetwork and developers〉</h2>
 167 <a href="https://fascode.net/">Fascode Network</a> is a creative team mainly composed of students.<br>
 168 We are developing <a href="https://fascode.net/projects/linux/alter/">Alter Linux</a> and <a href="https://fascode.net/projects/linux/serene/">SereneLinux</a>.
 169
 170 <h3>Official Twitter account</h3>
 171 <a href="https://twitter.com/FascodeNetwork">
 172     <img src="https://pbs.twimg.com/profile_images/1245716817831530497/JEkKX1XN_400x400.jpg" width="100px">
 173 </a>
 174 <a href="https://twitter.com/Fascode_JP">
 175     <img src="https://pbs.twimg.com/profile_images/1245682659231068160/Nn5tPUvB_400x400.jpg" width="100px">
 176 </a>
 177
 178 <h3>Developer Twitter account</h3>
 179 <a href="https://twitter.com/Hayao0819">
 180     <img src="https://avatars1.githubusercontent.com/u/32128205" width="100px">
 181 </a>
 182 <a href="https://twitter.com/Pixel_3a">
 183     <img src="https://avatars0.githubusercontent.com/u/48173871" width="100px">
 184 </a>
 185 <a href="https://twitter.com/yangniao23">
 186     <img src="https://avatars0.githubusercontent.com/u/47053316" width="100px">
 187 </a>
 188 <a href="https://twitter.com/Watasuke102">
 189     <img src="https://avatars3.githubusercontent.com/u/36789813" width="100px">
 190 </a>
 191 <a href="https://twitter.com/kokkiemouse">
 192     <img src="https://avatars0.githubusercontent.com/u/39451248" width="100px">
 193 </a>
 194 <a href="https://twitter.com/stmkza">
 195     <img src="https://avatars2.githubusercontent.com/u/15907797" width="100px">
 196 </a>
 197 <a href="https://twitter.com/yamad_linuxer">
 198     <img src="https://avatars1.githubusercontent.com/u/45691925" width="100px">
 199 </a>
 200 <a href="https://twitter.com/tukutun27">
 201     <img src="https://pbs.twimg.com/profile_images/1278526049903497217/CGMY5KUr.jpg" width="100px">
 202 </a>
 203 <a href="https://twitter.com/naoko1010hh">
 204     <img src="https://avatars1.githubusercontent.com/u/50263013" width="100px">
 205 </a>
 206
 207 <h3>Special Thanks</h3>
 208 <a href="https://twitter.com/s29kt_Tsukkun">
 209     <img src="https://avatars2.githubusercontent.com/u/74809846" width="100px">
 210 </a>
 211 <a href="https://twitter.com/sunset09160306">
 212     <img src="https://avatars1.githubusercontent.com/u/61398531" width="100px">
 213 </a>