aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnser <rostgans@tutamail.com>2026-08-21 18:03:51 +0200
committerAnser <rostgans@tutamail.com>2026-08-21 18:03:51 +0200
commit41fee62e621489514187103a52d5bf3440ec819c (patch)
treeb09239e9f716a0efbba206b7c6690352a4ed87c5 /README.md
parentdb877ae6cf1a3b24fd33ea9c5b56967d262e050c (diff)
refactor README.md simpler markdownHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md133
1 files changed, 81 insertions, 52 deletions
diff --git a/README.md b/README.md
index 03136a6..aca1294 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,28 @@
# 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, i want communism stuff but in C !
+- with emphasis on commiefetch
+- communism stuff, but written in C
-## roadmap
+## 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
+- [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... maybe
+### Future things
-- randomize the ascii art
-- change the way one chooses the ascii art for easy change
-- coloured ascii art
+- Randomize the ASCII art
+- Make choosing ASCII art easier
+- Coloured ASCII art
## Building / Installation
@@ -25,66 +32,88 @@
- GNU Make
- Standard C libraries
-### make commands
+### 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
-- 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
+Uninstall:
-### Build localy
+ sudo make uninstall
-```bash
-git clone https://codeberg.org/Anser/cfetch.git && \
-cd cfetch && \
-make
-```
+### Build locally
-### Build global
+ 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
-```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
-```
+ sudo make uninstall
+
+Afterwards, remove the git repository.
## Usage
-Run executable:
-```
-cfetch
-cfetch -v --version // prints the version of cfetch
-cfetch -h --help // prints the helper menu
-```
+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: 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
+At the current time, all configuration is done via the `cfetch.c` file.
-## Features - not much !
+- 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.
-| Feature | Linux |
-|---------|-------|
-| OS Info | OK |
-| Kernel | OK |
-| CPU | OK |
-| Memory | OK |
-| ascii_art | basic |
-| username | todo |
+## 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)