Assorted README.md updates
#36
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the various examples in
README.mdto reflect the need for adependencieskey underpkgx(per the test cases underfixtures/). I was banging my head on my keyboard for a second wondering why apkgx.yamlwithwasn't actually adding
typstto my$PATHuntil I checked the relevant test case and noticed that the syntax changed toHopefully this'll spare folks some of that frustration :)
While I was at it, I noticed that the TOML test cases (
Cargo.toml,pixi.toml, the various variations onpyproject.toml) specify# ---fences around the frontmatter, so that's now reflected in theREADME.mdexamples as well.I also removed the warning about command substitutions in environment variables, since those are no longer possible as of e73e559 (#841, #842). Tested both
BAD_ENV: $(pwd)andBAD_ENV: \pwd`to confirm that both still throw errors (though it'd probably be a good idea to havedev` throw a specific "don't try running commands" error in both cases).EDIT: also updated the "one-liner" example, addressing #22 as far as
README.mdgoes.