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

docs: make project README less platform-agnostic

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ic42a9508cee4a141e28d216bd024af546a6a6964
This commit is contained in:
raf 2026-02-07 13:10:37 +03:00
commit 7b01c44039
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/README.md
View file

@ -30,6 +30,11 @@ regressions in subsequent exports.
## Usage
NS provides both a web application for pretty visuals, and a terminal client (a
TUI) for rendering the statistics from your terminal.
### Web
Usage instructions are provided in the initial page. Simply navigate to the site
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,
@ -61,7 +66,7 @@ analysis you may compare two _named_ analyses at a time.
> 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 :)
### Snapshots
#### 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
@ -72,9 +77,12 @@ You can save an analysis as a snapshot from the save button on the bottom right.
## Hacking
This project is built with Vite, using Typescript-React (`.tsx`) and SolidJS. A
Nix shell is provided, and dependencies can be fetched with `pnpm` while inside
the dev shell.
This project is built with various web technologies. Namely we use Vite,
Typescript-React (`.tsx`) and SolidJS for most of our user interfaces.
The recommended approach for resolving dependencies is using Nix; a Nix shell is
provided, and dependencies can be fetched with `pnpm` while inside the dev
shell.
```bash
# Run the live server