instructions for tea.xyz/brewkit~0.2

This commit is contained in:
Max Howell 2023-02-12 11:56:04 -05:00
parent c39383da2d
commit 357ca23a8d
No known key found for this signature in database
GPG key ID: 741BB84EF5BB9EEC
3 changed files with 7 additions and 45 deletions

1
.gitignore vendored
View file

@ -1,4 +1,5 @@
/tea.out
/tea.linux
#TODO commit after v1
/deno.lock

View file

@ -25,17 +25,17 @@ $ cd pantry.core
# all the following commands operate in `./tea.out`
# your tea installation remains untouched
$ xc init
$ pkg init
# ^^ creates a “wip” package.yml
$ xc edit
$ pkg edit
# ^^ opens the new package.yml in your EDITOR
$ xc build
$ pkg build
# ^^ will probably require a (zero permissions) GitHub [PAT].
# Using `gh auth login` is the easiest way to set this up.
$ xc test
$ pkg test
# ^^ you need to write a test that verifies the package works
$ gh repo fork
@ -59,46 +59,6 @@ tea automatically builds new releases of packages *as soon as they are
released* (usually starting the builds within seconds). There is no need to
submit PRs for updates.
 
# Tasks
The following can all be run with `xc`, eg. `xc init`.
## Init
Creates a new package at `./projects/wip/$RANDOM_TEA_BLEND/package.yml`.
```sh
tea -E +tea.xyz/brewkit init
```
## Edit
Opens all wip packages in `$EDITOR`.
```sh
tea -E +tea.xyz/brewkit edit
```
## Build
Builds all wip packages to `./tea.out`.
```sh
tea -E +tea.xyz/brewkit build
```
## Test
Tests all wip packages.
```sh
tea -E +tea.xyz/brewkit test
```
[pantry.zero]: https://github.com/teaxyz/pantry.zero

View file

@ -16,7 +16,8 @@
},
"tea": {
"dependencies": {
"deno.land": "^1.30"
"deno.land": "^1.30",
"tea.xyz/brewkit": "^0.2"
},
"env": {
// if your primary tea.prefix is somewhere else then youll