NotAShelf/nix-evaluator-stats
1
0
Fork 0
mirror of https://github.com/NotAShelf/nix-evaluator-stats.git synced 2026-04-18 00:58:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: elaborate on snapshots feature; fix title alignment

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I364042f346ac5c58b07b3db95d0ebd856a6a6964
This commit is contained in:
raf 2026-01-23 00:43:57 +03:00
commit 288eb9ca54
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 21 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/README.md
View file

@ -1,10 +1,8 @@
# nix-evaluator-stats
<!-- markdownlint-disable MD033 --> <!-- markdownlint-disable MD033 -->
<div align="center"> <div align="center">
<h1 id="header">nix-evaluator-stats</h1>
<a alt="CI Status" href="https://github.com/NotAShelf/nix-evaluator-stats"> <a alt="CI Status" href="https://github.com/NotAShelf/nix-evaluator-stats">
<img <img
src="https://github.com/NotAShelf/nix-evaluator-stats/actions/workflows/check.yml/badge.svg" src="https://github.com/NotAShelf/nix-evaluator-stats/actions/workflows/check.yml/badge.svg"
alt="Lints & Formatting" alt="Lints & Formatting"
@ -37,14 +35,22 @@ and provide the JSON export (or a file) to render the statistics. The number of
rendered fields might differ based on your Nix version or implementation (Lix, rendered fields might differ based on your Nix version or implementation (Lix,
Snix, etc.) The classic usage looks like this: Snix, etc.) The classic usage looks like this:
<!-- markdownlint-disable MD013 -->
```bash ```bash
# Invoke a Nix command with NIX_SHOW_STATS=1 # Invoke a Nix command with NIX_SHOW_STATS=1
$ NIX_SHOW_STATS=1 nix eval nixpkgs#hello -- --option eval-cache false # disable eval-cache for accuracy $ NIX_SHOW_STATS=1 nix eval nixpkgs#hello -- --option eval-cache false # disable eval-cache for accuracy
# Or write to a file directly
$ NIX_SHOW_STATS_PATH=stats.json nix eval nixpkgs#hello -- --option eval-cache false
``` ```
<!-- markdownlint-enable MD013 -->
1. Create the JSON export 1. Create the JSON export
2. Copy it 2. Copy it if printed to stdout
3. Paste it in the input field that appears the first time you visit the site 3. Paste or upload it in the input field that appears the first time you visit
the site
Once you hit "Load", the JSON will be parsed and you'll be looking at a dash Once you hit "Load", the JSON will be parsed and you'll be looking at a dash
board of your export. By using the snapshot feature, i.e., saving a particular board of your export. By using the snapshot feature, i.e., saving a particular
@ -55,6 +61,15 @@ analysis you may compare two _named_ analyses at a time.
> UI bugs or areas where UI polish is very clearly missing. Please crate an > UI bugs or areas where UI polish is very clearly missing. Please crate an
> issue if the generated graph or the site UI looks off. Thanks :) > issue if the generated graph or the site UI looks off. Thanks :)
### Snapshots
Snapshots are an "experimental" (just means they're new and unpolished) feature
that lets you save an analysis in your browser storage with a name to be used
later on in the comparison view. At least two **named** analyses (i.e.,
snapshots) are required for an analysis.
You can save an analysis as a snapshot from the save button on the bottom right.
## Hacking ## Hacking
This project is built with Vite, using Typescript-React (`.tsx`) and SolidJS. A This project is built with Vite, using Typescript-React (`.tsx`) and SolidJS. A