diff --git a/README.md b/README.md index d602092a..d7f55ea3 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,22 @@ # Sailfish QML Workplace repo for creating diff patches -## How to manual? +## How-to (fully manual)? - Fork repo or request addition to organization -- Create branch named your patch name: -`git checkout -b my-patch-name` +- Create branch with your Patch name: `git checkout -b my-patch-name` - Apply changes -- Create diff: -`git diff master -- . ':!.github' > unified_diff.patch` -- Publish it to Patchmanager web catalog! +- Create diff: `git diff master -- . ':!.github' > unified_diff.patch` +- Publish it on Patchmanager's Web Catalog! -## How to automatic? +## How-to (semi-automated)? - Fork repo or request addition to organization -- Create branch named your patch name: -`git checkout -b my-patch-name` +- Create branch with your Patch name: `git checkout -b my-patch-name`
+ Alternatively this can be done by GitHub's web-frontend. - Apply changes -- You can copy additional files according to [pm2 guidelines](https://coderus.openrepos.net/pm2/usage/) to the 'patch' folder +- You can copy additional files according to the [Patchmanager guidelines](https://coderus.openrepos.net/pm2/usage/) to the `patch` folder - Create pull request -- Github CI will produce zip file for you -- Publish it to Patchmanager web catalog! \ No newline at end of file +- A CI workflow of this GitHub repo will [produce a ZIP file for you](https://github.com/sailfishos-patches/sailfish-qml/actions) +- Publish it on Patchmanager's Web Catalog! + +#### Side note +The content of this repo was created by executing `find /usr -name '*.qml' -o -name '*.js'` as root on a freshly installed SailfishOS.