From eeeafd18cd98078cadd9f9c2bd72a5c4ad9723ca Mon Sep 17 00:00:00 2001 From: Tim Martin Date: Fri, 11 Aug 2023 10:28:14 -0500 Subject: [PATCH] Rework README.md (#12) --- README.md | 37 +++++++++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9d53217..0a06804 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,36 @@ Template bucket for [Scoop](https://scoop.sh), the Windows command-line installer. -How do I install these manifests? ---------------------------------- +## How do I use this template? -To add this bucket, run `scoop bucket add https://github.com//`. To install, do `scoop install `. +1. Generate your own copy of this repository with the "Use this template" + button. +2. Allow all GitHub Actions: + - Navigate to `Settings` - `Actions` - `General` - `Actions permissions`. + - Select `Allow all actions and reusable workflows`. + - Then `Save`. +3. Allow writing to the repository from within GitHub Actions: + - Navigate to `Settings` - `Actions` - `General` - `Workflow permissions`. + - Select `Read and write permissions`. + - Then `Save`. +4. Document the bucket in `README.md`. +5. Replace the placeholder repository string in `bin/auto-pr.ps1`. +6. Create new manifests by copying `bucket/app-name.json.template` to + `bucket/.json`. +7. Commit and push changes. -How do I contribute new manifests? ----------------------------------- +## How do I install these manifests? -To make a new manifest contribution, please read the [Contributing Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md). +After manifests have been committed and pushed, run the following: ----- +```pwsh +scoop bucket add https://github.com// +scoop install / +``` -#### To use this template +## How do I contribute new manifests? -- Modify the Readme.md and the bin/auto-pr.ps1 files accordingly. -- Enable GitHub Actions for this repository. +To make a new manifest contribution, please read the [Contributing +Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md) +and [App Manifests](https://github.com/ScoopInstaller/Scoop/wiki/App-Manifests) +wiki page.