Skip to content

Commit c8f0825

Browse files
committed
Merge branch 'master' of github.com:M4cs/winfetch
2 parents c07aedb + b00b212 commit c8f0825

File tree

1 file changed

+23
-65
lines changed

1 file changed

+23
-65
lines changed

README.md

+23-65
Original file line numberDiff line numberDiff line change
@@ -11,95 +11,53 @@
1111

1212

1313
### Overview
14-
Winfetch is still extremely early in development. The configuration is minimal and there is little to no customization for titles until I add them! This is my first Go program and I have only known it as of last night (when creating this repository).
14+
Winfetch is an alternative program for neofetch/screenfetch made for Windows! It allows you to display system information through your command line without needing to have any hacky bash fixes to run neofetch. It's also faster!
15+
16+
For More information and detailed instructions on configuration and installation read the [Wiki here](https://github.com/M4cs/winfetch/wiki)
1517

1618
<p align="center">
1719
<img src="https://raw.githubusercontent.com/M4cs/winfetch/master/gitimages/preview.png" align="center" height="270px">
1820
<img src="https://raw.githubusercontent.com/M4cs/winfetch/master/gitimages/preview1.png" align="center" height="270px">
1921
</p>
2022

21-
### Installation
23+
## Installation
24+
25+
### Downloading Binary/Installer
2226

23-
#### Using Prebuilt Binary
27+
You can find the Binary and Installer in the [Releases Section](https://github.com/M4cs/winfetch/releases). If you download the installer it will install `winfetch.exe` to whichever path you specify, the default is `C:\
28+
Program Files\winfetch\winfetch.exe`.
2429

25-
Download from the releases tab [here](https://github.com/M4cs/winfetch/releases)
30+
If you download the binary alone in `.zip` format you can unzip and extract it to somewhere inside your `$PATH`.
2631

27-
Place this file somewhere inside your $PATH
32+
**Make sure wherever you install `winfetch` to is inside your $PATH! For more info refer [here](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/)**
2833

29-
#### Using `go get`
34+
<hr>
3035

31-
First install [Go](https://golang.org/)
36+
### Using `go get`
3237

33-
Then use `go get` from the command line to install:
38+
To install from go simply run:
3439

3540
```
3641
go get github.com/M4cs/winfetch
3742
```
3843

39-
Now you can run `winfetch` to get your system information to display!
44+
<hr>
4045

41-
#### Building From Source
46+
### Building From Source
4247

43-
Make sure you have Go installed then run:
48+
Clone the repository:
4449

4550
```
46-
git clone https://github.com/M4cs/winfetch
47-
cd winfetch
48-
go build
51+
git clone https://github.com/M4cs/winfetch.git
4952
```
5053

51-
You will now have a `winfetch.exe` file in your directory!
52-
53-
## Configuration
54-
55-
There isn't much to the config at the moment but you can find it at `.winfetch.json` in your Home folder.
56-
57-
The default config is as follows:
58-
59-
```json
60-
{
61-
"format": [
62-
"user",
63-
"sep",
64-
"uptime",
65-
"mem",
66-
"cpu",
67-
"cpuCores",
68-
"cpuThreads",
69-
"procs",
70-
"disk",
71-
"wversion",
72-
"gpus",
73-
"bios",
74-
"baseboard"
75-
],
76-
"showAscii": true,
77-
"useDefaultColors": true,
78-
"useSmallAscii": false,
79-
"asciiColor": "Blue",
80-
"useCustomAscii": false,
81-
"customAsciiPath": "",
82-
"userColor": "Red",
83-
"sepColor": "Red",
84-
"titleColor": "Green",
85-
"infoColor": "White",
86-
"titles": {
87-
"memory": "Memory",
88-
"cpu": "CPU #",
89-
"cpuCores": "CPU Cores",
90-
"cpuThreads": "CPU Threads",
91-
"gpus": "GPU #",
92-
"diskSize": "Disk Size",
93-
"windowsVersion": "Windows Ver.",
94-
"bios": "BIOS",
95-
"baseboard": "Baseboard",
96-
"processCount": "Processes",
97-
"uptime": "Uptime"
98-
}
99-
}
100-
```
54+
Run the following commands:
10155

102-
The formatting is order specific, each module will display based on it's place in the array. **All modules are displayed above and by default when you first install winfetch**
56+
```
57+
cd winfetch
58+
go build
59+
./winfetch.exe # This will be built inside the winfetch/ directory
60+
```
10361

10462
## Dependencies
10563

0 commit comments

Comments
 (0)