Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add install instructions to README #182

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xeruf
Copy link

@xeruf xeruf commented Jan 24, 2022

In case one needs to quickly copy it out on any exotic setup

@@ -1,27 +1,32 @@
<p align="center"><img src="https://user-images.githubusercontent.com/6799467/65944518-68834d80-e421-11e9-9b14-6ca26a16108a.png" width="350px"></p>
<h1 align="center">pfetch</h1>
<p align="center">A pretty system information tool written in POSIX sh</p><br>
<p align="center">A minimal yet pretty system profiler written in POSIX sh</p><br>
Copy link

Choose a reason for hiding this comment

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

Don't think profiler is the right word here. It's usually used in context of measuring some value like perfomance or complexity

Copy link
Author

Choose a reason for hiding this comment

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

I see, still wondering whether there might be a better word - to call it a "tool" is almost an overstatement, because for me that implies versatility, while this is more of a helper script.

Comment on lines -7 to +10
The goal of this project is to implement a simple system
information tool in POSIX `sh` using features built into
the language itself (*where possible*).
The goal of this project is to implement
a simple system information tool in POSIX `sh`
using features built into the language itself
(*where possible*).
Copy link

Choose a reason for hiding this comment

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

Why make lines shorter?

Copy link
Author

Choose a reason for hiding this comment

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

Makes editing the text a lot easier and diffs shorter because the lines are not split arbitrarily but semantically: https://sembr.org/

README.md Show resolved Hide resolved
Comment on lines +22 to +29
Installation is as simple as
copying the script into your PATH
and making it executable, e.g.:
```sh
cd /usr/local/bin
sudo wget https://raw.githubusercontent.com/dylanaraps/pfetch/master/pfetch
sudo chmod +x pfetch
```
Copy link

Choose a reason for hiding this comment

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

make install

Copy link
Author

Choose a reason for hiding this comment

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

for that I first have to clone the repo, and considering the minimal nature of this project that target machine might not even have git installed

Copy link

Choose a reason for hiding this comment

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

should use curl instead since its more common

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants