Update README.md, update stats, update ignore lists
- Update formatting for README.md - Update stats using .gitattributes - Remove obsolete entries from .gitignore - Use Git LFS for binary files (images), require re-commit binary assets
This commit is contained in:
parent
c204403404
commit
e2acd2f6dc
14
.gitattributes
vendored
14
.gitattributes
vendored
@ -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
|
||||
|
||||
10
.gitignore
vendored
10
.gitignore
vendored
@ -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
|
||||
111
README.md
111
README.md
@ -1,91 +1,86 @@
|
||||
# Fetch tool for linux written in Go with image support
|
||||
# goGoFetch
|
||||
|
||||

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

|
||||
|
||||
# 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
|
||||
Credits to `melvi` for Nix flake.
|
||||
|
||||
 foot
|
||||
```sh
|
||||
git clone https://codeberg.org/nekohepott/goGoFetch && cd goGoFetch
|
||||
nix build
|
||||
nix run --refresh git+https://codeberg.org/nekohepott/goGoFetch
|
||||
```
|
||||
|
||||
 xterm
|
||||
## Screenshots
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Loading…
Reference in New Issue
Block a user