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