This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
Add install instructions to README #182
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 minimal yet pretty system profiler written in POSIX sh</p><br> | ||
|
|
||
| <img src="https://user-images.githubusercontent.com/6799467/65945384-5bfff480-e423-11e9-863e-4e7cf16eb648.png" width="40%" align="right"> | ||
|
|
||
| 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*). | ||
|
Comment on lines
-7
to
+10
There was a problem hiding this comment. Makes editing the text a lot easier and diffs shorter because the lines are not split arbitrarily but semantically: https://sembr.org/ |
||
|
|
||
| The source code is extensively documented | ||
| and I hope it will act as a learning resource | ||
| for POSIX `sh` and simple information detection | ||
| across various different operating systems. | ||
|
|
||
| If anything in the source code is unclear | ||
| or is lacking in its explanation, open an issue. | ||
| Sometimes you get too close to something | ||
| and you fail to see the "bigger picture"! | ||
xeruf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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 | ||
| ``` | ||
|
Comment on lines
+22
to
+29
There was a problem hiding this comment. 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 There was a problem hiding this comment. should use |
||
|
|
||
| ## OS support | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.