|
11 | 11 |
|
12 | 12 |
|
13 | 13 | ### 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) |
15 | 17 |
|
16 | 18 | <p align="center">
|
17 | 19 | <img src="https://raw.githubusercontent.com/M4cs/winfetch/master/gitimages/preview.png" align="center" height="270px">
|
18 | 20 | <img src="https://raw.githubusercontent.com/M4cs/winfetch/master/gitimages/preview1.png" align="center" height="270px">
|
19 | 21 | </p>
|
20 | 22 |
|
21 |
| -### Installation |
| 23 | +## Installation |
| 24 | + |
| 25 | +### Downloading Binary/Installer |
22 | 26 |
|
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`. |
24 | 29 |
|
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`. |
26 | 31 |
|
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/)** |
28 | 33 |
|
29 |
| -#### Using `go get` |
| 34 | +<hr> |
30 | 35 |
|
31 |
| -First install [Go](https://golang.org/) |
| 36 | +### Using `go get` |
32 | 37 |
|
33 |
| -Then use `go get` from the command line to install: |
| 38 | +To install from go simply run: |
34 | 39 |
|
35 | 40 | ```
|
36 | 41 | go get github.com/M4cs/winfetch
|
37 | 42 | ```
|
38 | 43 |
|
39 |
| -Now you can run `winfetch` to get your system information to display! |
| 44 | +<hr> |
40 | 45 |
|
41 |
| -#### Building From Source |
| 46 | +### Building From Source |
42 | 47 |
|
43 |
| -Make sure you have Go installed then run: |
| 48 | +Clone the repository: |
44 | 49 |
|
45 | 50 | ```
|
46 |
| -git clone https://github.com/M4cs/winfetch |
47 |
| -cd winfetch |
48 |
| -go build |
| 51 | +git clone https://github.com/M4cs/winfetch.git |
49 | 52 | ```
|
50 | 53 |
|
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: |
101 | 55 |
|
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 | +``` |
103 | 61 |
|
104 | 62 | ## Dependencies
|
105 | 63 |
|
|
0 commit comments