purefetch 0.1.2

A fast, fastfetch-style system information tool written entirely in Rust with zero dependencies
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Contributing to purefetch

Thanks for your interest! purefetch aims to stay small, fast, and
**dependency-free**. Bug reports, ideas, and pull requests are all welcome.

## Ground rules

- **Zero dependencies.** No crates.io dependencies — the tool is `std` plus raw
  Linux syscalls. A PR that adds a dependency will be asked to drop it.
- **No panics, no blocking.** Detection modules read `/proc` and `/sys` and must
  return an empty `Vec` when data is missing rather than `unwrap()`-ing or
  spawning long-running work.
- **MSRV is 1.70** — don't use newer `std` APIs (CI checks this via clippy).
- Run `cargo fmt` and `cargo clippy` before submitting; CI enforces both.

## Building & checking

```sh
cargo build --release
cargo test
cargo fmt --all -- --check
cargo clippy --all-targets -- -D warnings
```

## Adding a distro logo

1. Create `assets/logos/<id>.txt`, where `<id>` matches the `/etc/os-release`
   `ID` (so auto-detection works). Format:

   ```
   COLOR: R;G;B
   <ascii art, one row per line>
   ```

   Keep it ≤ 40 columns wide and ~16–20 rows, and preserve leading spaces.
2. Add `<id>` to the `ORDER` list in `scripts/genlogos.py` (with any aliases).
3. Regenerate: `python3 scripts/genlogos.py` — it rewrites `src/logo.rs` and runs
   `rustfmt` on it. Don't edit `src/logo.rs` by hand.
4. Check it: `cargo run -- --logo <id>`.

## Adding an info module

Create `src/detect/<name>.rs` exposing `pub fn detect() -> crate::detect::Rows`,
then register it (label + function) in the `groups` table in `src/main.rs`. Use
`Row::val(...)` for a single value and return an empty `Vec` when unavailable.
`src/detect/cpu.rs` is the canonical example.

## Adding a CPU architecture

`src/sys.rs` issues raw syscalls per architecture. To add one, provide a
`syscall3` implementation (inline asm for that target's syscall convention) plus
the `SYS_STATFS` / `SYS_IOCTL` numbers, all behind `#[cfg(target_arch = "...")]`.
The `struct Statfs` layout is shared by LP64 targets; 32-bit targets would need
their own (`statfs64`) layout. Verify with `cargo check --target <triple>` and,
ideally, a run under `qemu-<arch>`.

## Commit & PR style

- Small, focused commits with a `<area>: <summary>` subject line.
- By submitting a pull request you agree that your contribution is dual-licensed
  under **MIT OR Apache-2.0**, per the terms in the README.