GithubHelp home page GithubHelp logo

domsson / nuru-cat Goto Github PK

View Code? Open in Web Editor NEW
6.0 1.0 0.0 29 KB

Display nuru images in your Terminal.

License: Creative Commons Zero v1.0 Universal

Shell 0.31% C 99.69%
nuru terminal console-application ascii-art ansi-art

nuru-cat's Introduction

nuru-cat

Display nuru images in your terminal.

Status / Overview

Early work in progress. Prototype alpha stage kinda stuff. Don't use yet.

Dependencies / Requirements

  • Terminal that supports 256 colors (8 bit color mode)
  • Requires TIOCGWINSZ to be supported (to query the terminal size)

Building / Running

You can compile it with the provided build script.

chmod +x ./build
./build

Installing

When asking nuru-cat to display images that use palettes, it will look for those in $XGD_CONFIG_HOME/glyphs and $XGD_CONFIG_HOME/colors accordingly. Hence, consider copying the provided palettes there. Assuming ~/.config to be $XGD_CONFIG_HOME, that would be:

mkdir ~/.config/nuru
cp -r ./nup/* ~/.config/nuru

Usage

nuru-cat [OPTIONS...] image-file

Options:

  • -C: clear the console before printing
  • -c FILE: path to color palette file to use
  • -g FILE: path to glyph palette file to use
  • -h: print help text and exit
  • -i: show image information and exit
  • -V: print version information and exit

Support

ko-fi

nuru-cat's People

Contributors

domsson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.