- C++ 88.1%
- CMake 8.9%
- Nix 2.6%
- Shell 0.4%
9aef26776cThis adds the campus weather information to the default layout. Some minor formatting work is also included along with small steps towards removing `using namespace std;` across the codebase. |
||
|---|---|---|
| .github | ||
| 3rd-party | ||
| cmake | ||
| include | ||
| meta | ||
| nix | ||
| src | ||
| tests | ||
| .envrc | ||
| .gitignore | ||
| .gitmodules | ||
| .ignore | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| Doxyfile | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| README.md | ||
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
-devversion 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.
If you just want to run things without a local copy, try:
nix run 'git+https://git.alugatuci.org/b0x207/peterfetch.git' -L -- <your UCINetID>
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.