generated from ScoopInstaller/BucketTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.bak
42 lines (33 loc) · 1.83 KB
/
README.md.bak
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Scoop Bucket Template
<!-- Uncomment the following line after replacing placeholders -->
<!-- [![Tests](https://github.com/<username>/<bucketname>/actions/workflows/ci.yml/badge.svg)](https://github.com/<username>/<bucketname>/actions/workflows/ci.yml) [![Excavator](https://github.com/<username>/<bucketname>/actions/workflows/excavator.yml/badge.svg)](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 shadow https://github.com/Shadow-XT/ShadowBucket
scoop install shadow/<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.