[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,11 +1,10 @@
all
# Ignore 80 character line length limit.
exclude_rule 'MD013'
# Ignore horizontal rule style.
exclude_rule 'MD035'
# Ignore emphasis used instead of a header.
exclude_rule 'MD036'
# Ignore first line in file should be a top level header.
exclude_rule 'MD041'
# Ignore code block style.
exclude_rule 'MD046'
rule 'MD003', style: :atx
exclude_rule 'MD002' # We use HTML <h1> tag as the top level header
exclude_rule 'MD013' # Ignore 80 character line length limit.
exclude_rule 'MD033' # We need HTML to center logo, which is not possible in pure Markdown
exclude_rule 'MD035' # Ignore horizontal rule style.
exclude_rule 'MD036' # Ignore emphasis used instead of a header.
exclude_rule 'MD041' # Ignore first line in file should be a top level header.
exclude_rule 'MD046' # Ignore code block style.

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>

17
images/discord.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 10 KiB

17
images/slack.svg Normal file
View File

@@ -0,0 +1,17 @@
<svg height="75" width="200" xmlns="http://www.w3.org/2000/svg">
<style>
image { height: 75px; width: 200px; }
/* dark mode detection */
image.light { display: inline; }
image.dark { display: none; }
@media (prefers-color-scheme: dark) {
image.light { display: none; }
image.dark { display: inline; }
}
</style>
<image x="0" class="light" href="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDI2LjUuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA2MTUuMiAyNDQuNCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgNjE1LjIgMjQ0LjQ7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRTAxRTVBO30KCS5zdDF7ZmlsbDojMzZDNUYwO30KCS5zdDJ7ZmlsbDojMkVCNjdEO30KCS5zdDN7ZmlsbDojRUNCMjJFO30KPC9zdHlsZT4KPHBhdGggZD0iTTIxOC4yLDE1OC4zbDYuMi0xNC40YzYuNyw1LDE1LjYsNy42LDI0LjQsNy42YzYuNSwwLDEwLjYtMi41LDEwLjYtNi4zYy0wLjEtMTAuNi0zOC45LTIuMy0zOS4yLTI4LjkKCWMtMC4xLTEzLjUsMTEuOS0yMy45LDI4LjktMjMuOWMxMC4xLDAsMjAuMiwyLjUsMjcuNCw4LjJsLTUuOCwxNC43Yy02LjYtNC4yLTE0LjgtNy4yLTIyLjYtNy4yYy01LjMsMC04LjgsMi41LTguOCw1LjcKCWMwLjEsMTAuNCwzOS4yLDQuNywzOS42LDMwLjFjMCwxMy44LTExLjcsMjMuNS0yOC41LDIzLjVDMjM4LjEsMTY3LjQsMjI2LjgsMTY0LjUsMjE4LjIsMTU4LjMiLz4KPHBhdGggZD0iTTQ1Ni4xLDEzOC43Yy0zLjEsNS40LTguOSw5LjEtMTUuNiw5LjFjLTkuOSwwLTE3LjktOC0xNy45LTE3LjlzOC0xNy45LDE3LjktMTcuOWM2LjcsMCwxMi41LDMuNywxNS42LDkuMWwxNy4xLTkuNQoJYy02LjQtMTEuNC0xOC43LTE5LjItMzIuNy0xOS4yYy0yMC43LDAtMzcuNSwxNi44LTM3LjUsMzcuNXMxNi44LDM3LjUsMzcuNSwzNy41YzE0LjEsMCwyNi4zLTcuNywzMi43LTE5LjJMNDU2LjEsMTM4Ljd6Ii8+CjxwYXRoIGQ9Ik0yODcuNSw2MS4zaDIxLjRWMTY2aC0yMS40VjYxLjN6Ii8+CjxwYXRoIGQ9Ik00ODEuNiw2MS4zVjE2Nkg1MDN2LTMxLjRsMjUuNCwzMS40aDI3LjRsLTMyLjMtMzcuM2wyOS45LTM0LjhoLTI2LjJMNTAzLDEyMi44VjYxLjNMNDgxLjYsNjEuM3oiLz4KPHBhdGggZD0iTTM3Mi41LDEzOC45Yy0zLjEsNS4xLTkuNSw4LjktMTYuNyw4LjljLTkuOSwwLTE3LjktOC0xNy45LTE3LjlzOC0xNy45LDE3LjktMTcuOWM3LjIsMCwxMy42LDQsMTYuNyw5LjJWMTM4Ljl6CgkgTTM3Mi41LDkzLjl2OC41Yy0zLjUtNS45LTEyLjItMTAtMjEuMy0xMGMtMTguOCwwLTMzLjYsMTYuNi0zMy42LDM3LjRzMTQuOCwzNy42LDMzLjYsMzcuNmM5LjEsMCwxNy44LTQuMSwyMS4zLTEwdjguNWgyMS40di03MgoJSDM3Mi41eiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNODUuOSwxMzguOGMwLDcuMy01LjksMTMuMi0xMy4yLDEzLjJzLTEzLjItNS45LTEzLjItMTMuMnM1LjktMTMuMiwxMy4yLTEzLjJoMTMuMlYxMzguOHoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTkyLjUsMTM4LjhjMC03LjMsNS45LTEzLjIsMTMuMi0xMy4yczEzLjIsNS45LDEzLjIsMTMuMnYzM2MwLDcuMy01LjksMTMuMi0xMy4yLDEzLjJzLTEzLjItNS45LTEzLjItMTMuMgoJVjEzOC44eiIvPgo8cGF0aCBjbGFzcz0ic3QxIiBkPSJNMTA1LjcsODUuOGMtNy4zLDAtMTMuMi01LjktMTMuMi0xMy4yczUuOS0xMy4yLDEzLjItMTMuMnMxMy4yLDUuOSwxMy4yLDEzLjJ2MTMuMkgxMDUuN3oiLz4KPHBhdGggY2xhc3M9InN0MSIgZD0iTTEwNS43LDkyLjVjNy4zLDAsMTMuMiw1LjksMTMuMiwxMy4ycy01LjksMTMuMi0xMy4yLDEzLjJINzIuNmMtNy4zLDAtMTMuMi01LjktMTMuMi0xMy4yczUuOS0xMy4yLDEzLjItMTMuMgoJSDEwNS43eiIvPgo8cGF0aCBjbGFzcz0ic3QyIiBkPSJNMTU4LjYsMTA1LjdjMC03LjMsNS45LTEzLjIsMTMuMi0xMy4yczEzLjIsNS45LDEzLjIsMTMuMnMtNS45LDEzLjItMTMuMiwxMy4yaC0xMy4yVjEwNS43eiIvPgo8cGF0aCBjbGFzcz0ic3QyIiBkPSJNMTUyLDEwNS43YzAsNy4zLTUuOSwxMy4yLTEzLjIsMTMuMnMtMTMuMi01LjktMTMuMi0xMy4yVjcyLjZjMC03LjMsNS45LTEzLjIsMTMuMi0xMy4yUzE1Miw2NS4zLDE1Miw3Mi42CglWMTA1Ljd6Ii8+CjxnPgoJPHBhdGggY2xhc3M9InN0MyIgZD0iTTEzOC44LDE1OC42YzcuMywwLDEzLjIsNS45LDEzLjIsMTMuMnMtNS45LDEzLjItMTMuMiwxMy4ycy0xMy4yLTUuOS0xMy4yLTEzLjJ2LTEzLjJIMTM4Ljh6Ii8+Cgk8cGF0aCBjbGFzcz0ic3QzIiBkPSJNMTM4LjgsMTUyYy03LjMsMC0xMy4yLTUuOS0xMy4yLTEzLjJzNS45LTEzLjIsMTMuMi0xMy4yaDMzLjFjNy4zLDAsMTMuMiw1LjksMTMuMiwxMy4ycy01LjksMTMuMi0xMy4yLDEzLjIKCQlIMTM4Ljh6Ii8+CjwvZz4KPC9zdmc+Cg==" />
<image x="0" class="dark" href="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDI2LjUuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA2MTUuMiAyNDQuNCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgNjE1LjIgMjQ0LjQ7IiB4bWw6c3BhY2U9InByZXNlcnZlIj4KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4KCS5zdDB7ZmlsbDojRkZGRkZGO30KCS5zdDF7ZmlsbDojRTAxRTVBO30KCS5zdDJ7ZmlsbDojMzZDNUYwO30KCS5zdDN7ZmlsbDojMkVCNjdEO30KCS5zdDR7ZmlsbDojRUNCMjJFO30KPC9zdHlsZT4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTIxOC4yLDE1OC4zbDYuMi0xNC40YzYuNyw1LDE1LjYsNy42LDI0LjQsNy42YzYuNSwwLDEwLjYtMi41LDEwLjYtNi4zYy0wLjEtMTAuNi0zOC45LTIuMy0zOS4yLTI4LjkKCWMtMC4xLTEzLjUsMTEuOS0yMy45LDI4LjktMjMuOWMxMC4xLDAsMjAuMiwyLjUsMjcuNCw4LjJsLTUuOCwxNC43Yy02LjYtNC4yLTE0LjgtNy4yLTIyLjYtNy4yYy01LjMsMC04LjgsMi41LTguOCw1LjcKCWMwLjEsMTAuNCwzOS4yLDQuNywzOS42LDMwLjFjMCwxMy44LTExLjcsMjMuNS0yOC41LDIzLjVDMjM4LjEsMTY3LjQsMjI2LjgsMTY0LjUsMjE4LjIsMTU4LjMiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQ1Ni4xLDEzOC43Yy0zLjEsNS40LTguOSw5LjEtMTUuNiw5LjFjLTkuOSwwLTE3LjktOC0xNy45LTE3LjlzOC0xNy45LDE3LjktMTcuOWM2LjcsMCwxMi41LDMuNywxNS42LDkuMQoJbDE3LjEtOS41Yy02LjQtMTEuNC0xOC43LTE5LjItMzIuNy0xOS4yYy0yMC43LDAtMzcuNSwxNi44LTM3LjUsMzcuNXMxNi44LDM3LjUsMzcuNSwzNy41YzE0LjEsMCwyNi4zLTcuNywzMi43LTE5LjJMNDU2LjEsMTM4Ljd6IgoJLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTI4Ny41LDYxLjNoMjEuNFYxNjZoLTIxLjRWNjEuM3oiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQ4MS42LDYxLjNWMTY2SDUwM3YtMzEuNGwyNS40LDMxLjRoMjcuNGwtMzIuMy0zNy4zbDI5LjktMzQuOGgtMjYuMkw1MDMsMTIyLjhWNjEuM0w0ODEuNiw2MS4zeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMzcyLjUsMTM4LjljLTMuMSw1LjEtOS41LDguOS0xNi43LDguOWMtOS45LDAtMTcuOS04LTE3LjktMTcuOXM4LTE3LjksMTcuOS0xNy45YzcuMiwwLDEzLjYsNCwxNi43LDkuMlYxMzguOQoJeiBNMzcyLjUsOTMuOXY4LjVjLTMuNS01LjktMTIuMi0xMC0yMS4zLTEwYy0xOC44LDAtMzMuNiwxNi42LTMzLjYsMzcuNHMxNC44LDM3LjYsMzMuNiwzNy42YzkuMSwwLDE3LjgtNC4xLDIxLjMtMTB2OC41aDIxLjR2LTcyCglIMzcyLjV6Ii8+CjxwYXRoIGNsYXNzPSJzdDEiIGQ9Ik04NS45LDEzOC44YzAsNy4zLTUuOSwxMy4yLTEzLjIsMTMuMnMtMTMuMi01LjktMTMuMi0xMy4yczUuOS0xMy4yLDEzLjItMTMuMmgxMy4yVjEzOC44eiIvPgo8cGF0aCBjbGFzcz0ic3QxIiBkPSJNOTIuNSwxMzguOGMwLTcuMyw1LjktMTMuMiwxMy4yLTEzLjJzMTMuMiw1LjksMTMuMiwxMy4ydjMzYzAsNy4zLTUuOSwxMy4yLTEzLjIsMTMuMnMtMTMuMi01LjktMTMuMi0xMy4yCglWMTM4Ljh6Ii8+CjxwYXRoIGNsYXNzPSJzdDIiIGQ9Ik0xMDUuNyw4NS44Yy03LjMsMC0xMy4yLTUuOS0xMy4yLTEzLjJzNS45LTEzLjIsMTMuMi0xMy4yczEzLjIsNS45LDEzLjIsMTMuMnYxMy4ySDEwNS43eiIvPgo8cGF0aCBjbGFzcz0ic3QyIiBkPSJNMTA1LjcsOTIuNWM3LjMsMCwxMy4yLDUuOSwxMy4yLDEzLjJzLTUuOSwxMy4yLTEzLjIsMTMuMkg3Mi42Yy03LjMsMC0xMy4yLTUuOS0xMy4yLTEzLjJzNS45LTEzLjIsMTMuMi0xMy4yCglIMTA1Ljd6Ii8+CjxwYXRoIGNsYXNzPSJzdDMiIGQ9Ik0xNTguNiwxMDUuN2MwLTcuMyw1LjktMTMuMiwxMy4yLTEzLjJzMTMuMiw1LjksMTMuMiwxMy4ycy01LjksMTMuMi0xMy4yLDEzLjJoLTEzLjJWMTA1Ljd6Ii8+CjxwYXRoIGNsYXNzPSJzdDMiIGQ9Ik0xNTIsMTA1LjdjMCw3LjMtNS45LDEzLjItMTMuMiwxMy4ycy0xMy4yLTUuOS0xMy4yLTEzLjJWNzIuNmMwLTcuMyw1LjktMTMuMiwxMy4yLTEzLjJTMTUyLDY1LjMsMTUyLDcyLjYKCVYxMDUuN3oiLz4KPGc+Cgk8cGF0aCBjbGFzcz0ic3Q0IiBkPSJNMTM4LjgsMTU4LjZjNy4zLDAsMTMuMiw1LjksMTMuMiwxMy4ycy01LjksMTMuMi0xMy4yLDEzLjJzLTEzLjItNS45LTEzLjItMTMuMnYtMTMuMkgxMzguOHoiLz4KCTxwYXRoIGNsYXNzPSJzdDQiIGQ9Ik0xMzguOCwxNTJjLTcuMywwLTEzLjItNS45LTEzLjItMTMuMnM1LjktMTMuMiwxMy4yLTEzLjJoMzMuMWM3LjMsMCwxMy4yLDUuOSwxMy4yLDEzLjJzLTUuOSwxMy4yLTEzLjIsMTMuMgoJCUgxMzguOHoiLz4KPC9nPgo8L3N2Zz4K" />
</svg>

After

Width:  |  Height:  |  Size: 7.0 KiB