nitch++

A rewrite of nitch in C++ with some extra features.

Currently takes 2 milliseconds to run on my machine.

Contents

• Why?
• Support
• Dependencies
• Building and Installation
• Usage
• Configuration

Why?

Because nitch has been unmaintained since 2022 and I think it was a neat project.

Support

nitch++ currently supports MacOS and the following Linux distributions, although I have not been able to test all of them. If any problems arise, please create an issue.

• Arch
• EndeavourOS
• Artix
• Manjaro
• Debian
• Ubuntu
• PopOS!
• Mint
• Fedora
• RedHat
• Void
• OpenSUSE
• Gentoo
• NixOS
• Zorin
• Slackware
• CentOS
• MacOS

Dependencies

Note

Having a NerdFont installed on your system is required to make the icons display.

nitch++ relies on g++, cmake, and either ninja or make for compiling and building.

Building and Installation

For those on Arch based systems, I have a PKGBUILD available.

For everyone else:

Clone the repository and go into the new directory

git clone https://github.com/clamsfeel2/nitchplusplus.git && cd nitchplusplus

Create and cd into the build directory

mkdir build && cd build

Run CMake, then build the project

cmake .. && make install

or with ninja

cmake -GNinja .. && ninja install

To uninstall nitch++ run

make uninstall

or with ninja

ninja uninstall

Usage

Just run

nitch++

To not use NerdFonts.

nitch++ --nonerd

To not display ascii art

nitch++ --noascii

To display ascii art of a different distro

nitch++ --distro [distro name]

A list of valid distro names can be found in the example config file

To clear the screen before nitch++ is ran

nitch++ --clear

Adjust the box width in the output

nitch++ --width [integer >= 6]

Padding adjustment for each row/column is not currently supported, making this feature more of a gimmick for now. Still fun, I think.

Output of nitch++ --help

-a, --noascii
     run nitch++ without displaying ascii art.

-n, --nonerd
     do not use nerd fonts.

-d, --distro [distro name]
     display ascii art of specified distro.

-w, --width [>=6]
     change the width of the output box with specified value.

-c, --clear
     clear the screen before running nitch++.

Configuration

In order to use the config file, put the example config file into the config directory. By default nitch++ will use $XDG_CONFIG_HOME/nitch++/config.toml as the path to your config file. However, you are able to change the path by setting NITCHPP_CONFIG_FILE environment variable to a path ending in config.toml