diff --git a/.gitattributes b/.gitattributes index 24a8e87..2d4d0de 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,15 @@ +# .gitattributes + +# Aliases +[attr]lfs filter=lfs diff=lfs merge=lfs -text +# EOL +* text=auto eol=lf +# LFS +*.png lfs +# Stats +*.git* linguist-language=Shell +*.sum linguist-generated +*.toml linguist-detectable +*.yml linguist-language=YAML +*.yaml linguist-detectable *.png filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore index 8cc2912..6811c26 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +1,12 @@ -./idea +# .gitignore + idea/* /main -result/ -*result* +result* ./src ./pkg ./goGoFetch /gogofetch-git-r14.ff1fcf9-1-x86_64.pkg.tar.zst ./gogofetch-git -/.idea/awesomeProject.iml -/.idea/go.imports.xml -/.idea/vcs.xml -/.idea/workspace.xml /goGoFetch -/gogofetch \ No newline at end of file +/gogofetch diff --git a/README.md b/README.md index a134fd6..50f7ac6 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,86 @@ -# Fetch tool for linux written in Go with image support +# goGoFetch -![Fetch image](assets/screenshot.png "fetch") +Fetch tool for Linux written in Go with image support -# Install -you can get gogofetch on AUR! -```bash -yay -S gogofetch-git -``` -also chafa is dependency for gogofetch +![goGoFetch: screenshot](assets/screenshot.png "fetch") -# Usage -basic usage: -```bash +## Usage + +```sh gogofetch -``` -to show custom image : -```bash + +# show custom image gogofetch -l path -``` -If the custom image is a GIF, it will animate and gogofetch will keep running until you stop it (Ctrl+C). -to show custom image and set custom width: -```bash + +# If the custom image is a GIF, it will animate and gogofetch will keep running until you stop it (Ctrl+C). +# to show custom image and set custom width: gogofetch -l path -w 250 -``` -to place logo on the left (default) or right: -```bash + +# place logo on the left (default) or right: gogofetch -p left gogofetch -p right -``` -to show help message: -```bash + +# help gogofetch -h ``` -config file is created at `~/.config/gogofetch/config.toml`, all parameters are described in config file. +> [Note!] +> Configuration file is created at `~/.config/gogofetch/config.toml`. -# Nix -credits to melvi for flake +## Install -to build with nix: -```bash -git clone https://codeberg.org/nekohepott/goGoFetch -cd goGoFetch -nix build -``` -to run with nix: -``` -nix run --refresh git+https://codeberg.org/nekohepott/goGoFetch -``` -to install with nixos: +### Arch Linux -1. Add to inputs: +```sh +yay -S gogofetch-git ``` + +Also `chafa` is dependency for goGoFetch + +### NixOS + +```nix +# add to inputs goGoFetch.url = "git+https://codeberg.org/nekohepott/goGoFetch"; -``` -2. Add to packages (system-wide or home-manager): -``` + +# add to packages (system-wide or home-manager) environment.systemPackages = [ inputs.goGoFetch.packages.${pkgs.system}.default ]; -``` -or -``` + +# or home.packages = [ inputs.goGoFetch.packages.${pkgs.system}.default ]; ``` -3. Run rebuild and then you can run fetch with *gogofetch* command - -# Build -to build: +```sh +# run rebuild and then you can run fetch +gogofetch ``` -git clone https://codeberg.org/nekohepott/goGoFetch -cd goGoFetch + +## Build + +### Linux + +```sh +git clone https://codeberg.org/nekohepott/goGoFetch && cd goGoFetch go build -o gogofetch ./src -``` -and run: -``` ./gogofetch ``` -# Some screenshots +### Nix Flake -![alacritty](assets/alacritty.png "alacritty") alacritty +Credits to `melvi` for Nix flake. -![foot](assets/foot.png "foot") foot +```sh +git clone https://codeberg.org/nekohepott/goGoFetch && cd goGoFetch +nix build +nix run --refresh git+https://codeberg.org/nekohepott/goGoFetch +``` -![necrokall](assets/xterm.png "xterm") xterm +## Screenshots +![goGoFetch: alacritty screenshot](assets/alacritty.png "alacritty") +![goGoFetch: foot screenshot](assets/foot.png "foot") +![goGoFetch: necrokall screenshot](assets/xterm.png "xterm")