+ +
+ +When running `onefetch --image ./My-picture.jpg`, the program looks for the first `Image Backend` supported by the terminal and use it to display the requested image instead of the Ascii logo. + +If you decide to go manual, and want to force the use of a specific image backend --> `onefetch --image ./My-picture.jpg --image-backend sixel|kitty|iterm` + +### Sixel + +The Sixel protocol is handled by multiple terminal emulators such as [`xterm`](https://invisible-island.net/xterm/) (enabled via flag `-ti 340`), [`mlterm`](https://wiki.ubuntu.com/Mlterm) and [`WezTerm`](https://github.com/wez/wezterm) which are actively maintained. + +You can increase the color resolution using the `--color-resolution` flag. + +### Kitty + +The kitty terminal graphics protocol used on the terminal of the same name allows the program running in the terminal, to render graphics to the screen of the terminal emulator. + +### ITerm + +The iTerm inline image protocol supported by iTerm2 (also WezTerm) allows to display images within the terminal. \ No newline at end of file diff --git a/.github/wiki/Installation.md b/.github/wiki/Installation.md new file mode 100644 index 000000000..bd2c26413 --- /dev/null +++ b/.github/wiki/Installation.md @@ -0,0 +1,202 @@ +This wiki page will guide you through getting onefetch working on your system. + +[![Packaging status](https://repology.org/badge/vertical-allrepos/onefetch.svg)](https://repology.org/project/onefetch/versions) + +# Table of Contents + +* [Universal Install](#universal-install) + * [Cargo](#cargo) + * [Snap](#snap) + * [Build from source](#build-from-source) +* [OS/Distro Packages](#osdistro-packages) + * [Alpine Linux](#alpine-linux) + * [Arch](#arch) + * [Fedora](#fedora) + * [FreeBSD](#freebsd) + * [Funtoo](#funtoo) + * [macOS](#macos) + * [Homebrew](#homebrew) + * [MacPorts](#macports) + * [NetBSD](#netbsd) + * [NixOS](#nixos) + * [openSUSE](#openSUSE-Leap-or-Tumbleweed) + * [Ubuntu](#ubuntu-ppa) + * [Void Linux](#void-linux) + * [Windows](#windows) + * [Winget](#Winget) + * [Scoop](#scoop) + * [Chocolatey](#chocolatey) + +# Universal + +If your architecture is supported by the pre-built binaries, you can download them from the [releases page](https://github.com/o2sh/onefetch/releases). + +## Cargo + +First, install `rustup` to get the `rust` compiler installed on your system (using the recommended `curl https://sh.rustup.rs -sSf | sh -s` installation method) and then + +``` +cargo install onefetch +``` + +This method will build the binary from source. + +To update, run + +``` +cargo install onefetch --force +``` + +## Snap + +For a system with Snap installed, run + +``` +snap install onefetch +``` + +The stable version will be installed for you automatically. + +## Build from source + +First, install `rustup` to get the `rust` compiler installed on your system (using the recommended `curl https://sh.rustup.rs -sSf | sh -s` installation method) and then + +``` +git clone https://github.com/o2sh/onefetch +cd onefetch +make install +``` + +# OS/Distro Packages + +## Alpine Linux + +1. Update repositories + - `apk update` +2. Install the package + - `apk add onefetch` + + +## Arch + +Onefetch is available in the official repos. + +- Install the package + - `pacman -S onefetch` + +## Fedora + +Install it from the COPR + +``` +sudo dnf copr enable varlad/onefetch +sudo dnf install onefetch +``` + +## FreeBSD + +Install it from the official repositories + +- `pkg install onefetch` + +## Funtoo + +Funtoo has an autogenerated onefetch package in the official kits: + +- `emerge app-misc/onefetch` + +## MacOS + +### HomeBrew + +Install `onefetch` with Homebrew + +``` +brew install onefetch +``` + +To update, run + +``` +brew upgrade onefetch +``` + +### MacPorts + +Install `onefetch` with MacPorts + +``` +sudo port selfupdate +sudo port install onefetch +``` + +To update run, + +``` +sudo port upgrade onefetch +``` + +## NetBSD + +Install it from the official repositories. + +- `pkg_add onefetch` + + +## NixOS + +Install it from the official repositories + +- `nix-env -i onefetch` + + +## openSUSE Leap or Tumbleweed + +Install it from the official repositories. + +- `zypper install onefetch` + + +## Ubuntu (ppa) + +``` +sudo add-apt-repository ppa:o2sh/onefetch +sudo apt-get update +sudo apt-get install onefetch +``` + +If your Ubuntu version isn't supported, use [snap](#snap). + +## Void Linux + +Install it from the official repositories + +- `sudo xbps-install -S onefetch` + + +## Windows + +### Winget + +You can install onefetch using [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/) + +``` +winget install onefetch +``` + +### Scoop + +For [Scoop](https://scoop.sh/) users, onefetch is available from the "Extras" bucket + +``` +scoop bucket add extras +scoop install onefetch +``` + +### Chocolatey + +If you prefer to use [Chocolatey](https://chocolatey.org/) to manage software, it can be installed like so + +``` +choco install onefetch +``` \ No newline at end of file diff --git a/.github/wiki/_Footer.md b/.github/wiki/_Footer.md new file mode 100644 index 000000000..95fce2a5c --- /dev/null +++ b/.github/wiki/_Footer.md @@ -0,0 +1,2 @@ +- 📰 [Wiki Home](https://github.com/o2sh/onefetch/wiki) +- 🛖 [Project Home](https://github.com/o2sh/onefetch) \ No newline at end of file diff --git a/.github/wiki/_Sidebar.md b/.github/wiki/_Sidebar.md new file mode 100644 index 000000000..821f3e3b1 --- /dev/null +++ b/.github/wiki/_Sidebar.md @@ -0,0 +1,10 @@ +- **[Home](https://github.com/o2sh/onefetch/wiki)** +- **General** + - [Installation](https://github.com/o2sh/onefetch/wiki/installation) + - [Getting started](https://github.com/o2sh/onefetch/wiki/getting-started) +- **Options** + - [Command-line options](https://github.com/o2sh/onefetch/wiki/command-line-options) +- **Images** + - [Image in the terminal](https://github.com/o2sh/onefetch/wiki/images-in-the-terminal) +- **Ascii** + - [Ascii file format](https://github.com/o2sh/onefetch/wiki/ascii-art) \ No newline at end of file diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml new file mode 100644 index 000000000..131520cd1 --- /dev/null +++ b/.github/workflows/wiki.yml @@ -0,0 +1,19 @@ +name: Sync Wiki +on: + push: + branches: [main] + paths: + - ".github/wiki/**" + + workflow_dispatch: + +jobs: + update-wiki: + runs-on: ubuntu-latest + name: Sync Wiki + + steps: + - uses: actions/checkout@v3 + - uses: spenserblack/actions-wiki@v0.1 + with: + token: ${{ secrets.WIKI_TOKEN }}