aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: aca12941f662719f1d100a8ef43cf310f8d04721 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# cfetch

A fastfetch / commiefetch-like system information tool written in C.

The idea is basically:

> I want communism stuff, but in C!

## Idea

- fastfetch / commiefetch in C
- with emphasis on commiefetch
- communism stuff, but written in C

## Roadmap

- [x] 0.1.0: Get basic system information on the screen
- [x] 0.1.1: Print ASCII art with system information
- [ ] 0.1.2+: More system information and ASCII art next to it

### Future things

- Randomize the ASCII art
- Make choosing ASCII art easier
- Coloured ASCII art

## Building / Installation

### Dependencies

- GCC compiler
- GNU Make
- Standard C libraries

### Make commands

Clone the project:

    git clone https://codeberg.org/Anser/cfetch.git

Build locally:

    make

Build with debug flags:

    make debug

Install system-wide:

    sudo make install

Remove the local build:

    make clean

Uninstall:

    sudo make uninstall

### Build locally

    git clone https://codeberg.org/Anser/cfetch.git
    cd cfetch
    make

### Build globally

    git clone https://codeberg.org/Anser/cfetch.git
    cd cfetch
    sudo make install

### Uninstall

    sudo make uninstall

Afterwards, remove the git repository.

## Usage

Run:

    cfetch

Show version:

    cfetch -v
    cfetch --version

Show help:

    cfetch -h
    cfetch --help

## Configuration

At the current time, all configuration is done via the `cfetch.c` file.

- Change ASCII art by modifying `info.ascii_art`.
- Change information by commenting out the corresponding `get_` functions.
- Currently, the corresponding `printf` statements in the `print_system_info` function in `ascii.c` also need to be commented out.

## Features

Not much yet!

| 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)