From 16d79850b3ff0e23ba0c651a29583de83dbe559c Mon Sep 17 00:00:00 2001 From: Journey Date: Mon, 5 Feb 2024 19:36:44 -0600 Subject: [PATCH] Update main repo readme. --- README.md | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index da1e7fe1..eb1adb14 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,44 @@ # Chocolatey Packages -### Automatic Updating +## Automatic Updating -[![Build status](https://github.com/JourneyOver/chocolatey-packages/workflows/Update%20Packages/badge.svg)](https://github.com/JourneyOver/chocolatey-packages/actions?query=workflow%3A%22Update+Packages%22) +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/JourneyOver/chocolatey-packages/package-updater.yml)](https://github.com/JourneyOver/chocolatey-packages/actions/workflows/package-updater.yml) [![Update Status](https://img.shields.io/badge/Update-Status-blue.svg)](https://gist.github.com/JourneyOver/508bb89c4cc35b67842940c60310532b) [![Force Test Status](https://img.shields.io/badge/Update-Force%20Test%20Status-red.svg)](https://gist.github.com/JourneyOver/13f08beca5db513521762b5c4ce53d58) [![chocolatey/JourneyOver](https://img.shields.io/badge/Chocolatey-JourneyOver-008b85.svg)](https://chocolatey.org/profiles/JourneyOver) [![Open Source Helpers](https://www.codetriage.com/journeyover/chocolatey-packages/badges/users.svg)](https://www.codetriage.com/journeyover/chocolatey-packages) -### Description +## Description -This repository contains chocolatey packages created and maintained by [JourneyOver](https://chocolatey.org/profiles/JourneyOver) that are updated daily +This repository contains chocolatey packages created and maintained by [JourneyOver](https://chocolatey.org/profiles/JourneyOver), updated daily. ## Guidelines ### Reporting broken/outdated packages -If packages from this repository fail to install or a new version has been released by the software vendor for a particular package, please report it in any or all of the following ways: +If packages fail to install or a new version is released, please report it in any of the following ways: -Github issue: +- [GitHub issue](https://github.com/JourneyOver/chocolatey-packages/issues/new) -### Broken packages +#### Broken packages -If the package fails to install or uninstall via choco, please include debug information from the console: -`choco install PKGID --yes --verbose --debug` +If the package fails to install or uninstall via choco, include debug information from the console: -### Outdated packages +```shell +choco install PKGID --yes --verbose --debug +``` -If the package is not up to date, please include the following if possible: -latest version number -release date -URL to the install binary +#### Outdated packages + +If the package is not up-to-date, include the following if possible: + +- Latest version number +- Release date +- URL to the install binary ### Contributing -1. As much as possible, these packages are [automatic](https://chocolatey.org/docs/automatic-packages) and all automatic packages will use the [AU module](https://github.com/majkinetor/au). -2. If allowed, packages will include the packaged software directly in the `.nupkg` archive instead of downloading it from another site at the time of install. Only tools that allow redistribution in their license can be embedded and such packages must include two additional files in the `tools` directory - `VERIFICATION.txt` and `License.txt`. -3. Code is written for humans, not for computers (i.e. assembly). Thus, Make the code readable, but also efficient. The goal is not to obfuscate. If another person wants to help, they need to understand it too! -4. All the metadata attributes in the package needs to be filled up as much as possible. If a metadata tag is empty, it is because the information is not available. In case of the metadata not being publicly available, you could try to contact the publisher of the software. +1. Whenever possible, use the [AU module](https://github.com/majkinetor/au) for automatic packages. +2. If allowed, include the packaged software directly in the `.nupkg` archive instead of downloading it at install time. Only tools allowing redistribution in their license can be embedded, and such packages must include `VERIFICATION.txt` and `License.txt` in the `tools` directory. +3. Prioritize readable code without sacrificing efficiency. Code should be understandable by others. +4. Fill up metadata attributes in the package as much as possible. Empty metadata tags indicate unavailable information. If metadata is not publicly available, attempt to contact the software publisher.