aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 03136a67577b71c6b6d32458210373a8c2b500da (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# cfetch

## Idea

- fastfetch / commiefetch in C
- with emphasis on commiefetch, i want communism stuff but in C !

## roadmap

- [x] 0.1.0: get some basic system information on the screen
- [x] 0.1.1: print out the ascii art with systeminformation
- [ ] 0.1.2+: some more systeminformation plus print ascii art left of sys information

### future things... maybe

- randomize the ascii art
- change the way one chooses the ascii art for easy change
- coloured ascii art

## Building / Installation

### Dependencies

- GCC compiler
- GNU Make
- Standard C libraries

### make commands

- git clone this project
  - `git clone https://codeberg.org/Anser/cfetch.git`
- `make` for local install (e.g. binary will be placed inside the project folder)
- `make debug` for additional debug compiler flags
- `sudo/doas make install` for systemwide install (requieres root privileges)
- `make clean` for local removal
- `sudo/doas make uninstall` for systemwide uninstallation

### Build localy

```bash
git clone https://codeberg.org/Anser/cfetch.git && \
cd cfetch && \
make
```

### Build global

```bash
git clone https://codeberg.org/Anser/cfetch.git && \
cd cfetch && \
sudo make install
```
### Uninstall

```bash
sudo make uninstall
# after that remove the git folder
```

## Usage

Run executable:
```
cfetch
cfetch -v --version // prints the version of cfetch
cfetch -h --help    // prints the helper menu
```

## Configuration

at the current time all configuration is done via the `cfetch.c` file.
- change ascii art: manipulate `info.ascii_art`
- change infomation: comment the `get_<name>` functions.
  - unconveniently one has to comment out the corrosponding printf statemant in `ascii.c` `print_system_info` function

## Features - not much !

| Feature | Linux |
|---------|-------|
| OS Info | OK    |
| Kernel  | OK  |
| CPU     | OK    |
| Memory  | OK    |
| ascii_art  | basic    |
| username  | todo    |


## Reference
- [Commiefetch](https://github.com/amalxloop/commiefetch)
- [Fastfetch](https://github.com/fastfetch-cli/fastfetch)