docs tweaks

This commit is contained in:
Max Howell 2023-10-11 07:19:52 -04:00
parent 68778be96b
commit a05cbca2da
No known key found for this signature in database
GPG key ID: 741BB84EF5BB9EEC

View file

@ -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” (tard binaries) and upload them to our CDN. Thus your