Updated Readme
Some checks failed
Tests / WindowsPowerShell (push) Has been cancelled
Tests / PowerShell (push) Has been cancelled
Some checks failed
Tests / WindowsPowerShell (push) Has been cancelled
Tests / PowerShell (push) Has been cancelled
This commit is contained in:
parent
838b6a238d
commit
88ad3a7679
1 changed files with 11 additions and 26 deletions
37
README.md
37
README.md
|
@ -3,40 +3,25 @@
|
|||
<!-- 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.
|
||||
My bucket for [Scoop](https://scoop.sh), the Windows command-line installer.
|
||||
|
||||
## How do I use this template?
|
||||
## Requirements
|
||||
|
||||
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.
|
||||
1. You need to use Windows 10 / 11
|
||||
2. You need to have [Scoop](https://scoop.sh) installed
|
||||
3. You need to have git installed and in the Path. In case you have not, run `scoop install git`
|
||||
|
||||
## 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>
|
||||
scoop bucket add kb01-bucket https://git.kb-one.de/kb01/scoop-bucket
|
||||
scoop install kb01-bucket/<manifestname>
|
||||
```
|
||||
|
||||
## How do I contribute new manifests?
|
||||
## What Apps are Included in 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.
|
||||
| App Name | Website(s) | Installation Command |
|
||||
| -------- | -------------------------------------------- | ----------------------------------- |
|
||||
| FancyWM | [GitHub](https://github.com/FancyWM/fancywm) | `scoop install kb01-bucket/fancywm` |
|
||||
|
|
Loading…
Add table
Reference in a new issue