Peterfetch

A terminal fetch application akin to neofetch but for UCI students.

Contributing

Before contributing to the project, please take a look at CONTRIBUTING.md.

Obtaining the Source

This project uses Git Submodules. When cloning, make sure to either clone with --recursive or run git submodule update --init --recursive after cloning.

Building

System Dependencies

Ensure your system has the following dependencies:

• A C++ compiler with support for C++20 (see this table)
• CMake
• Either make or ninja
• libcurl

Note: For Debian based distributions, you may need to install the -dev version of some packages

Nix/NixOS Systems

If your system has Nix installed, you can use the provided flake.nix if you prefer.

Activate the development shell with nix develop or if you have nix-direnv installed, simply direnv allow. Then, follow the build instructions below.

Alternatively, you can directly build with nix build and run with nix run, skipping the steps below.

Note: To view the build logs easier, use nix build -L --log-format bar-with-logs.

Build Commands

You can configure the project with:

cmake -B build

And then compile with:

cmake --build build

# Or
./meta/build.sh

This will produce a binary called peterfetch in the build directory. You can run it with ./build/peterfetch.