Skip to content

Commit 4e23a23

Browse files
committed
added documentation
1 parent e077854 commit 4e23a23

File tree

1 file changed

+66
-1
lines changed

1 file changed

+66
-1
lines changed

Diff for: README.md

+66-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,66 @@
1-
# Sysgrab
1+
# Sysgrab
2+
3+
Sysgrab is a lightweight and customizable system information tool for fetching and displaying system details such as OS, architecture, CPU, memory, and more in the terminal.
4+
5+
<p align="center"><a><img width="800" alt="Thumbnail Image of Sysgrab" src="https://www.siddhp.me/_next/image?url=%2Fsysgrab.png&w=3840&q=75"></a></p>
6+
7+
Users can configure Sysgrab's base and accent colors, and add ASCII art of their choice through the CLI or by directly editing the configuration files.
8+
9+
Sysgrab is compatible with all Linux distributions.
10+
11+
## Installation
12+
13+
To install Sysgrab, follow these steps:
14+
15+
1. **Download the latest release**:
16+
17+
Download the latest version of `sysgrab-release.zip` from the [releases page](https://github.com/siddhp1/Sysgrab/releases/) and extract it.
18+
19+
2. **Add Sysgrab to your PATH**:
20+
21+
Add the extracted directory to your system PATH to make `sysgrab` accessible from anywhere in the terminal.
22+
23+
Add this line to `.bashrc` or `.zshrc` to make the change persistent.
24+
25+
```bash
26+
export PATH=$PATH:/path/to/sysgrab-directory
27+
```
28+
29+
30+
31+
## Usage
32+
33+
Run Sysgrab with the following command:
34+
35+
```bash
36+
sysgrab [OPTIONS]
37+
```
38+
39+
**Options:**
40+
```text
41+
(no option) Display system information
42+
-h, --help Show a help message and exit
43+
-v, --version Display version information and exit
44+
-b, --base-color [r,g,b] Set base color in the format r,g,b
45+
-a, --accent-color [r,g,b] Set accent color in the format r,g,b
46+
```
47+
48+
## Configuration
49+
50+
To configure Sysgrab, follow these steps:
51+
52+
1. **Configure colors**:
53+
54+
To configure the colors, edit the `config.txt` file, or run the following command with rgb values of choice:
55+
56+
```bash
57+
sysgrab --base-color r,g,b --accent-color r,g,b
58+
```
59+
60+
2. **Add art**:
61+
62+
To configure the art, paste any ASCII art in the `art.txt` file.
63+
64+
## License
65+
66+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)