Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve installation instructions in the README #1182

Merged
merged 5 commits into from
Aug 15, 2024
Merged

Improve installation instructions in the README #1182

merged 5 commits into from
Aug 15, 2024

Conversation

AlbydST
Copy link
Contributor

@AlbydST AlbydST commented Aug 13, 2024

I added installation instructions for

  • Exherbo
  • GNU Guix
  • Solus
  • Slackware
  • Void Linux
  • RebornOS
  • Chocolatey on Windows

I also improved installation instructions for Termux and changed sudo to su -c in commands, this executes the command as root regardless of the presence of sudo / doas / sup.

@CarterLi
Copy link
Member

  • RebornOS

I don't think installing an ancient version is a good idea.

changed sudo to su -c in commands, this executes the command as root regardless of the presence of sudo / doas / sup

I don't like this

@AlbydST
Copy link
Contributor Author

AlbydST commented Aug 14, 2024

I don't think installing an ancient version is a good idea.

Should I specify that it's outdated or remove it entirely?

I don't like this

Can you explain why?

@CarterLi
Copy link
Member

CarterLi commented Aug 15, 2024 •
edited
Loading

Can you explain why?

They are different. For example, su requires root user's password, while sudo requires current user's.

I actually consider removing sudo or whatever. Since you are using linux, you should know these basic stuff. The purpose of this section is to let users know fastfetch is packaged officially by your distro, instead of teaching users how to use their package managers.

@CarterLi
Copy link
Member

Should I specify that it's outdated or remove it entirely?

Remove it

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
Replace sudo with doas depending on what you use.
* Arch Linux: `su -c pacman -Syy fastfetch`. An outdated version of fastfetch is also available [on the AUR](https://aur.archlinux.org/packages/fastfetch-git).
* Fedora: `su -c dnf install fastfetch`
* Gentoo: `su -c emerge --ask --verbose app-misc/fastfetch`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why --verbose?

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
* Fedora: `su -c dnf install fastfetch`
* Gentoo: `su -c emerge --ask --verbose app-misc/fastfetch`
* Alpine: `su -c apk add --upgrade fastfetch`
* NixOS: `su -c nix-env -iA nixos.fastfetch`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change?

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
* Exherbo: `su -c cave resolve --execute app-misc/fastfetch`
* GNU Guix: `su -c guix install fastfetch`
* Solus: `su -c eopkg install fastfetch`
* Slackware: With [sbopkg](https://www.sbopkg.org/index.php), run `su -c sbopkg -i fastfetch` to install [the fastfetch SlackBuild](https://slackbuilds.org/repository/15.0/system/fastfetch/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove With *** to install ***

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
Comment on lines 74 to 77
* Fastfetch is available [in the Termux repository](https://github.com/termux/termux-packages/tree/master/packages/fastfetch), run `pkg install fastfetch`

* You can also install fastfetch directly with APT: `apt install fastfetch`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't change this one.

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
@@ -103,7 +112,7 @@ Logos can be heavily customized too; see the [logo documentation](https://github

1. Fastfetch is actively maintained.
2. Fastfetch is faster. As the name suggests.
3. Fastfetch has a greater number of features, though by default fastfetch only has a few modules enabled; use `fastfetch -c all` to find what you want.
3. Fastfetch has a greater number of features, though by default fastfetch only has a few modules enabled; use `fastfetch -c all.jsonc` to find what you want.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

CarterLi
CarterLi reviewed Aug 15, 2024
View reviewed changes
README.md Outdated
@@ -112,7 +121,7 @@ Logos can be heavily customized too; see the [logo documentation](https://github

A local IP (10.x.x.x, 172.x.x.x, 192.168.x.x) has nothing to do with privacy. It only makes sense if you are on the same network, for example, if you connect to the same Wi-Fi network.

Actually the `Local IP` module is the most useful module for me personally. I (@CarterLi) have several VMs installed to test fastfetch and often need to SSH into them. I have fastfetch running on shell startup and I never need to type `ip addr` manually.
Actually the `Local IP` module is the most useful module for me personally. I ([@CarterLi](https://github.com/CarterLi)) have several VMs installed to test fastfetch and often need to SSH into them. I have fastfetch running on shell startup and I never need to type `ip addr` manually.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this

@CarterLi CarterLi merged commit bbb873c into fastfetch-cli:dev Aug 15, 2024
13 checks passed
CarterLi added a commit to CarterLi/fastfetch that referenced this pull request Aug 23, 2024
@AlbydST @CarterLi
Doc: Improve installation instructions in the README (fastfetch-cli#1182
7d94890 
)

* Improve installation instructions in the README

* Revert some stuff

* Update README.md

---------

Co-authored-by: Carter Li <CarterLi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CarterLi CarterLi CarterLi left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlbydST @CarterLi