goGoFetch/README.md

99 lines
1.8 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# goGoFetch
Fetch tool for Linux written in Go with image support
![goGoFetch: screenshot](assets/screenshot.png "fetch")
## Usage
```bash
gogofetch
# show custom image
gogofetch -l path
# to show custom image and set custom width:
gogofetch -l path -w 250
# place logo on the left (default) or right:
gogofetch -p left
gogofetch -p right
# help
gogofetch -h
```
> [Note!]
> Configuration file is created at `~/.config/gogofetch/config.toml`.
## Install
### Arch Linux
```bash
yay -S gogofetch-git
```
### Gentoo
```bash
eselect repository add nekohepott git https://codeberg.org/nekohepott/neko-overlay.git
emerge --sync nekohepott
emerge -av gogofetch
```
Also see: <https://codeberg.org/nekohepott/neko-overlay>.
### NixOS
```nix
# add to inputs
goGoFetch.url = "git+https://codeberg.org/nekohepott/goGoFetch";
# add to packages (system-wide or home-manager)
environment.systemPackages = [
inputs.goGoFetch.packages.${pkgs.system}.default
];
# or
home.packages = [
inputs.goGoFetch.packages.${pkgs.system}.default
];
```
```bash
# run rebuild and then you can run fetch
gogofetch
```
## Build
### Linux
```bash
git clone https://codeberg.org/nekohepott/goGoFetch && cd goGoFetch
make build
./gogofetch
```
### Nix Flake
```bash
git clone https://codeberg.org/nekohepott/goGoFetch && cd goGoFetch
nix build
nix run --refresh git+https://codeberg.org/nekohepott/goGoFetch
```
## Screenshots
![goGoFetch: alacritty screenshot](assets/alacritty.png "alacritty")
![goGoFetch: foot screenshot](assets/foot.png "foot")
![goGoFetch: necrokall screenshot](assets/xterm.png "xterm")
## Special thanks❤
- [koru](https://codeberg.org/koru) for contributing and literally
saving this repo when i broke it.
- [melvi](https://codeberg.org/melvi) for Nix flake.
- [Jakepys](https://codeberg.org/Jakepys) for contributing.