From dc216635453537bce59fb2d9cc17c39fa1aa49eb Mon Sep 17 00:00:00 2001 From: Max Howell Date: Thu, 9 Mar 2023 11:49:03 -0500 Subject: [PATCH] bye bye pantry.zero --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 650ee792..0cebef7a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,32 @@ ![tea](https://tea.xyz/banner.png) -This pantry† is the complement to [pantry.core]. +This pantry is the complement to [pantry.core]. -Longer term it will be split out into more pantries, some of which we hope -will be maintained by their own communities. -> † see [pantry.zero] for “what is a pantry” +# What is a Pantry? -# Use with tea/cli +Pantries provide consistent metadata about open source packages. This +metadata shouldn’t require manual collection, but at this current state in +open source it does. -[tea/cli] clones/updates this pantry and [pantry.core] when installed with -the installer or when you run `tea --sync`. At this time pantries are not -versioned. +It is collected and duplicated thousands of times. A huge waste of effort. + +tea aims to eradicate this wasted effort, though unfortunately, the journey +there will require—to some extent—doing that duplication one more time. + +## Doing it a Little Better This Time + +Our format is YAML, which is at least non-proprietary and could be used by +other tools without an independent parser. And we’re pulling in data from +other sources as much as possible, eg. versions are taken from the +“source” whenever possible.   # Contributing -Assuming you have tea+magic installed: +Assuming you have tea (/w magic) installed: ```sh $ git clone https://github.com/teaxyz/pantry.extra @@ -47,11 +55,13 @@ $ git push origin my-new-package $ gh pr create ``` -> `pkg` can be run without magic via `tea -E pkg` (this dev-env provides `+tea.xyz/brewkit`). -> `gh` can be run without magic via `tea gh`. -> `git` can be run without magic via `tea git`. +> * `pkg` can be run without magic via `tea -E pkg` (this dev-env provides `+tea.xyz/brewkit`). +> * `gh` can be run without magic via `tea gh`. +> * `git` can be run without magic via `tea git`. +> * `pkg build` and `pkg test` take a `-L` flag to run in a Linux Docker container +> * All commands take an optional pkg-spec eg. `pkg build zlib.net^1.1` -While in a pantry dev-env you can run commands from any built packages +While inside a pantry dev-env you can run commands from any built packages provided you specified their `provides:` key. ## Packaging Guide @@ -84,19 +94,9 @@ $ gh pr checkout https://github.com/teaxyz/pantry.extra/pull/123 $ pkg edit ``` -  - -# Dependencies - -| Project | Version | -|-----------------|---------| -| tea.xyz/brewkit | ^0.3 | - - -[pantry.zero]: https://github.com/teaxyz/pantry.zero [pantry.core]: https://github.com/teaxyz/pantry.core -[wiki]: https://github.com/teaxyz/pantry.zero/wiki +[wiki]: https://github.com/teaxyz/pantry.extra/wiki [tea/cli]: https://github.com/teaxyz/cli [discussion]: https://github.com/orgs/teaxyz/discussions [PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token