laoxong/ScoopBucket
1
0
Fork 0
mirror of https://github.com/laoxong/ScoopBucket synced 2024-11-23 02:45:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rework README.md (#12)

Browse Source
This commit is contained in:
Tim Martin 2023-08-11 10:28:14 -05:00 committed by GitHub
parent dd46c49b5e
commit eeeafd18cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -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 <bucketname> https://github.com/<username>/<bucketname>`. To install, do `scoop install <manifest>`.
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.
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 <bucketname> https://github.com/<username>/<bucketname>
scoop install <bucketname>/<manifestname>
```
#### 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.