[readme]: Revert #7795, disable some rules in linter (#7811)

* readme: Revert and various improvements

* Make github happy

* Update README.md

* Update images

* Disable `MD002`

* Make linter happy
This commit is contained in:
supechicken
2023-01-07 01:28:54 +08:00
committed by GitHub
parent 4aa1313ae8
commit ea06c1ee59
4 changed files with 64 additions and 37 deletions

View File

@@ -1,17 +1,17 @@
# Chromebrew
![Chromebrew logo](/images/brew.png)
The Missing Package Manager For Chrome OS
<div align="center">
<img src="images/brew.png" alt="Chromebrew icon">
<h1>Chromebrew</h1>
<p>The Missing Package Manager For Chrome OS</p>
</div>
## Chat With Us
_Discord is not currently syncing messages with Slack_
[![Slack Invite](https://cdn.bfldr.com/5H442O3W/at/pl546j-7le8zk-838dm2/Slack_RGB.png?auto=webp&format=png)](mailto:crewonslack@gmail.com?subject=Slack%20invitation%20link%20request&body=Auto-generated%20by%20README.md)
[![Discord Invite](https://discord.com/assets/ff41b628a47ef3141164bfedb04fb220.png)](https://discord.gg/QRrzBXN)
<div>
<a href="mailto:crewonslack@gmail.com?subject=Slack invitation link request&amp;body=This email is auto-generated by README.md" target="_blank"><img src="./images/slack.svg" alt="Slack Invite" align="middle"></a>
<a href="https://discord.gg/QRrzBXN" target="_blank"><img src="./images/discord.svg" alt="Discord Invite" align="middle"></a>
</div>
## Overview
@@ -53,18 +53,6 @@ Then download and run the installation script below:
curl -Ls git.io/vddgY | bash
```
On a rooted Google OnHub, the command needs to be run with the "chronos" user. In order to make su work, a password is needed for the chronos user.
```bash
# passwd chronos
Changing password for chronos.
Enter new UNIX password:
Retype new UNIX password:
# su - chronos
Password:
$ curl -Ls git.io/vddgY | bash
```
## Help
Please check out the [wiki](https://github.com/chromebrew/chromebrew/wiki) to find out more information about Chromebrew including helpful tips, resource links and frequently asked questions.
@@ -73,8 +61,8 @@ Also please check existing [issues](https://github.com/chromebrew/chromebrew/iss
## Usage
```bash
crew [-k|--keep] [...]
```text
crew <command> <package1> [<package2> ...]
```
Where available commands are:
@@ -103,7 +91,7 @@ Available packages are listed in the [packages directory](https://github.com/chr
Chromebrew will wipe its `BREW_DIR` (`/usr/local/tmp/crew` by default) after installation unless you pass `-k` or `--keep` when running `crew install`.
```bash
```text
crew install --keep [...]
```
@@ -111,6 +99,12 @@ crew install --keep [...]
Copyright 2013-2023 Michal Siwek and [all the awesome contributors](https://github.com/chromebrew/chromebrew/graphs/contributors). This project including all of its source files is released under the terms of [GNU General Public License (version 3 or later)](http://www.gnu.org/licenses/gpl.txt). This project embeds [docopt.rb](https://github.com/docopt/docopt.rb) at lib/docopt.rb. We retain its [MIT license](https://github.com/chromebrew/chromebrew/blob/master/lib/docopt.LICENSE).
[![GNU General Public License](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![MIT License](https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg)](https://mit-license.org/)
<div>
<a rel="license-software" href="https://www.gnu.org/licenses/gpl-3.0.en.html">
<img alt="GNU General Public License" src="https://www.gnu.org/graphics/gplv3-127x51.png" height="31" />
</a>
<img src="about:blank" width="15px"> <!-- acting a space between two images -->
<a rel="license-docopt" href="https://mit-license.org/">
<img alt="MIT License" src="https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg" height="31" />
</a>
</div>