diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 29 insertions, 6 deletions
@@ -1,8 +1,21 @@ -# Idea +# cfetch +## Idea - fastfetch / commiefetch in C - with emphasis on commiefetch, i want communism stuff but in C ! -# Install +## roadmap +- [x] 0.1.0: get some basic system information on the screen +- [ ] 0.1.1: print out the ascii art with systeminformation +- [ ] 0.1.2+: some more systeminformation plus print ascii art left of sys information + +## Building / Installation + +### Dependencies +- GCC compiler +- GNU Make +- Standard C libraries + +### make commands - git clone this project - `git clone https://codeberg.org/Anser/cfetch.git` @@ -11,21 +24,31 @@ - `make clean` for local removal - `sudo/doas make uninstall` for systemwide uninstallation -## install localy +### Build localy + ```bash git clone https://codeberg.org/Anser/cfetch.git && \ cd cfetch && \ make ``` -## install global +### Build global + ```bash git clone https://codeberg.org/Anser/cfetch.git && \ cd cfetch && \ sudo make install ``` -# Features - not much ! +## Usage + +Run executable: +``` +cfetch +``` + +## Features - not much ! + | Feature | Linux | |---------|-------| | OS Info | OK | @@ -36,6 +59,6 @@ sudo make install | ascii_art | todo | -# Reference +## Reference - [Commiefetch](https://github.com/amalxloop/commiefetch) - [Fastfetch](https://github.com/fastfetch-cli/fastfetch) |