From d6cf4d754704055d36cae40574b7de8da493ecd9 Mon Sep 17 00:00:00 2001 From: Trenly Date: Fri, 15 Mar 2024 14:59:54 -0500 Subject: [PATCH] Standardize whitespace in Authoring.md --- doc/Authoring.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/Authoring.md b/doc/Authoring.md index d9007fd61efdc..fae71b47b0b23 100644 --- a/doc/Authoring.md +++ b/doc/Authoring.md @@ -40,6 +40,7 @@ You should take a look at our [Manifest Specification]. Don't worry. If this is Manifests submitted to the Windows Package Manager Community Repository should be submitted as a multi-file manifest. The minimum required files are a [version][versionSchema] file, a [defaultLocale][defaultLocaleSchema] file and an [installer][installerSchema] file. ## Creating your first manifest + Once you have a package in mind that doesn't already exist in the repository, you can now start [creating your package manifest](https://docs.microsoft.com/en-us/windows/package-manager/package/manifest?tabs=minschema%2Cversion-example). We recommend using the [Windows Package Manager Manifest Creator (a.k.a Winget-Create)](https://github.com/microsoft/winget-create) to help you generate your manifest. Winget-Create is a command line tool that will prompt you for relevant metadata related to your package. Once you are done, Winget-Create will validate your manifest to verify that it is correct and allow you to submit your newly-created manifest directly to the winget-pkgs repository by linking your GitHub account. Alternatively, you can use the [YamlCreate.ps1 Script](Tools/YamlCreate.ps1). More information on using YamlCreate is found in the [script documentation](doc/tools/YamlCreate.md). ## Installer Architectures @@ -47,6 +48,7 @@ If you are authoring a manifest yourself one of the imporant things to note rela ### How do I install Winget-Create? + You can either [download the latest release of Winget-Create](https://github.com/microsoft/winget-create/releases) from its GitHub repository or use **Winget** to install it for you by running the following command: ```powershell @@ -54,6 +56,7 @@ winget install wingetcreate ``` ### Creating your manifest with Winget-Create + Now that you have Winget-Create installed onto your machine, you are ready to generate your first manifest by running the [New command](https://github.com/microsoft/winget-create/blob/main/doc/new.md). To do so, simply run the following command in your terminal: ```powershell @@ -64,6 +67,7 @@ There are many other commands available in Winget-Create to help you [update exi ## Validation + If you decide to create or edit your manifest by manually editing the YAML, it is important to make sure that you are validating your manifest. You can do this by running the [validate command](https://aka.ms/winget-command-validate) from **Winget** which will tell you if your manifest is valid, or which parts need to be fixed: ```powershell @@ -71,6 +75,7 @@ winget validate --manifest ``` ## Testing + It is important to test your manifest before submission to ensure it meets the repository's quality standards. While it isn't possible to describe everything that we check for when reviewing contributions, testing your manifest helps keep the quality of contributions high and increases the chance of your contribution being accepted. * Manifests should be tested to ensure applications can install unattended