search

tweag / nixpkgs-graph-explorer

Explore the nixpkgs dependency graph
MIT License
15 stars 0 forks source link

Small improvements to READMEs #99

Closed smelc closed 1 year ago

smelc commented 1 year ago

What this PR does

This PR augments the READMEs in a few places, to make it easier for newcomers to find their way into the project. I didn't mention that you seem to be using direnv, as I used Nix directly personally. Feel free to request to change that.

How to trust this PR

  1. Go to https://github.com/tweag/nixpkgs-graph-explorer/tree/smelc%40tiny-improvement-readmes
  2. Look at the rendering of the top-level README, try the new links. Observe they work.
  3. Go to https://github.com/tweag/nixpkgs-graph-explorer/tree/smelc@tiny-improvement-readmes/core
  4. Observe that the README in core renders well
smelc commented 1 year ago

Oh damn I hadn't seen https://github.com/tweag/nixpkgs-graph-explorer/pull/96 was in the making.

smelc commented 1 year ago

I will review https://github.com/tweag/nixpkgs-graph-explorer/pull/96 as I'm in a good position now to see if it's welcoming to newcomers :smile_cat: and get back to this one afterwards if still needed.

smelc commented 1 year ago

Closing in favor of #96. I backported improvements of this PR to #96.