ivabus/pantry
1
0
Fork 0
mirror of https://github.com/ivabus/pantry synced 2025-06-08 08:20:32 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

README tweaks

Browse source
This commit is contained in:
Max Howell 2023-02-15 06:16:02 -05:00
parent e8c224a942
commit 914a6370e3
No known key found for this signature in database
GPG key ID: 741BB84EF5BB9EEC
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -18,6 +18,8 @@ versioned.
# Contributing
Assuming you have tea+magic installed:
```sh
$ git clone https://github.com/teaxyz/pantry.extra
@ -33,8 +35,8 @@ $ pkg edit
# ^^ opens the new package.yml in your EDITOR
$ pkg build
# ^^ will probably require a (zero permissions) GitHub [PAT].
# using `gh auth login` is the easiest way to set this up.
# ^^ needs a zero permissions GITHUB_TOKEN to use the GitHub API
# either set `GITHUB_TOKEN` or run `gh auth login`
$ pkg test
# ^^ you need to write a test that verifies the package works
@ -45,6 +47,10 @@ $ git push origin my-new-package
$ gh pr create
```
> `pkg` can be run without magic via `tea +tea.xyz/brewkit pkg`.
> `gh` can be run without magic via `tea gh`.
> `git` can be run without magic via `tea git`.
## Packaging Guide
Packaging can be cumbersome.