Skip to content

Commit 20b25b6

Browse files
committed
update doc
1 parent 5f70905 commit 20b25b6

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ In any cases the following 2 steps should be done before using project :
2020
1. Generate an access token on your GitHub account to be able to run [Komac](https://github.com/russellbanks/Komac).
2121
2. Create a fork from [winget-pkgs](https://github.com/microsoft/winget-pkgs) to handle your pull requests for manifests - Also take care to validate all requirements to be able to contribute to Microsoft repositories.
2222

23-
If you want to use the existing docker image (**<span style="color: green">recommended</span>**) or use the dockerfile to build image then you can skip the other depedencies.
23+
If you want to use the existing docker image (recommended) or use the dockerfile to build image then you can skip the other depedencies.
2424

25-
If you want to test the script localy then you need to be on Linux or WSL if using Windows (as this is an sh script) and to install the following distribution dependencies :
25+
26+
If you want to test the script localy (useful for debug) then you need to be on Linux or WSL if using Windows (as this is an sh script) and to install the following distribution dependencies :
2627
* Basic dependencies (Example on Ubuntu)
2728
```sh
2829
apt-get update && apt-get install -y --no-install-recommends --no-install-suggests git wget curl jq ca-certificates
@@ -33,7 +34,7 @@ If you want to test the script localy then you need to be on Linux or WSL if usi
3334
dpkg -i komac_2.10.1-1_amd64.deb
3435
```
3536

36-
### Usage (Docker)
37+
### Usage (Docker) - ${\textsf{\color{lightgreen}Recommended}}$
3738
For a lot of reasons, it is more convient (at least for me) to "containerize" a script rather than running it as it is.
3839
The docker image can be run using 5 parameters (passed as runtime `ENV` settings) :
3940
- `<MAINTAINER_REPO>` : The GitHub project where your winget-pkgs fork is located, in the format *githubName/winget-pkgs-fork*.
@@ -57,17 +58,12 @@ The docker image can be run using 5 parameters (passed as runtime `ENV` setting
5758
sudo docker run -e MAINTAINER_REPO=... -e PUBLISHER_REPO=... -e WINGET_PACKAGE=... -e GIT_TOKEN=... -e MODE=latest senacra/wingetmus:v0.1.0
5859
```
5960

60-
### Usage (Localy) - <span style="color: red"> not recommended </span>
61+
### Usage (Localy) - ${\textsf{\color{orange}Not Recommended}}$
6162
The update_manifest.sh basically takes the exact same parameters as the docker.
62-
- `<MAINTAINER_REPO>` : The GitHub project where your winget-pkgs fork is located, in the format *githubName/winget-pkgs-fork*.
63-
- `<PUBLISHER_REPO>` : The GitHub project where the package releases are located, in the format *githubName/project_name*.
64-
- `<WINGET_PACKAGE>`: The name of the package (as declared in winget manifest) that you want to track and update, in the format *Publisher.PackageName*.
65-
- `<GIT_TOKEN>`: Your PAT for your GitHub account with the winget-pkgs fork.
66-
- (opt) `<MODE>` : a mode string to know if you want to track only for upcomming releases (default) or if you want to also create manifest for all past releases (use value *full*).
6763

6864
For example :
6965
```sh
70-
./update_manifest.sh myName/winget-pkgs-fork AwesomePublisher/TopPackage AwesomePublisher.TopPackage this_should_look_random
66+
./update_manifest.sh myName/winget-pkgs-fork AwesomePublisher/TopPackage AwesomePublisher.TopPackage this_should_look_random latest
7167
```
7268

7369

0 commit comments

Comments
 (0)