From a05cbca2dab7dfacb254500f2bf807a8cd6c16b8 Mon Sep 17 00:00:00 2001 From: Max Howell Date: Wed, 11 Oct 2023 07:19:52 -0400 Subject: [PATCH] docs tweaks --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 98f5f4b7..886b7932 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,8 @@ $ git clone https://github.com/pkgxdev/pantry $ cd pantry -$ dev +$ dev # https://docs.pkgx.sh/dev +# ^^ IMPORTANT! Otherwise the `pkg` command cannot be found $ pkg init # ^^ creates a “wip” package.yml @@ -43,6 +44,11 @@ $ gh pr create While inside the pantry `dev` environment you can run commands from any built packages provided you specified their `provides:` key. +## BrewKit + +We use a special package called [`brewkit`] to build packages both here and +in CI/CD. `brewkit` provides the `pkg` command. + ## GitHub Codespaces `pantry` also works in GitHub Codespaces. The default configuration @@ -50,24 +56,15 @@ provides with the repository will install/update `pkgx` at the time you attach, so you should be able to quickly work on or test packages in a remote linux environment (or work from a device with just a web browser). -## Providers - -If the package you want to add to the pantry can be executed simply eg. you -want `foo` to run `npx foo`, then you can add a one-line entry to -[`npmjs.com/provider.yml`]. - -We currently also support this for `pipx`. Adding support for other such -dependency manager execution handlers is easy and welcome. - -At this time, if the package has `pkgx` dependencies or requires compilation, -it should be packaged as a `package.yml`. - ## Packaging Guide Packaging can be cumbersome. Our [wiki] is our packaging knowledge base. For other assistance, start a [discussion]. +The best way to figure out solutions for your problems is to read other +examples from the pantry. + ## After Your Contribution We build “bottles” (tar’d binaries) and upload them to our CDN. Thus your