diff options
| author | Matthew Strapp <matt@mattstrapp.net> | 2024-10-28 13:37:20 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-28 13:37:20 -0500 |
| commit | 7f1529eb1c6be69318f95f2ce90b09bcf0eec232 (patch) | |
| tree | 72b1a2adb1ac248f6dda903b89e6c77ee84531a0 /README.md | |
| download | scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar.gz scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar.bz2 scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar.lz scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar.xz scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.tar.zst scoop-7f1529eb1c6be69318f95f2ce90b09bcf0eec232.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a53d3d7 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Scoop Bucket Template + +<!-- Uncomment the following line after replacing placeholders --> +<!-- [](https://github.com/<username>/<bucketname>/actions/workflows/ci.yml) [](https://github.com/<username>/<bucketname>/actions/workflows/excavator.yml) --> + +Template bucket for [Scoop](https://scoop.sh), the Windows command-line installer. + +## How do I use this template? + +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/<app-name>.json`. +7. Commit and push changes. +8. If you'd like your bucket to be indexed on `https://scoop.sh`, add the + topic `scoop-bucket` to your repository. + +## How do I install these manifests? + +After manifests have been committed and pushed, run the following: + +```pwsh +scoop bucket add <bucketname> https://github.com/<username>/<bucketname> +scoop install <bucketname>/<manifestname> +``` + +## How do I contribute new manifests? + +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. |