From 4f54ec00945740fbbcdd6dbbbede7b71f05b4947 Mon Sep 17 00:00:00 2001 From: Kaleb Luedtke Date: Thu, 14 Oct 2021 10:33:03 -0500 Subject: [PATCH] Chore: Add references to YamlCreate documentation (#93) --- AUTHORING_MANIFESTS.md | 2 +- README.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/AUTHORING_MANIFESTS.md b/AUTHORING_MANIFESTS.md index 1ea35fd4bf51e..03e82bfe7db59 100644 --- a/AUTHORING_MANIFESTS.md +++ b/AUTHORING_MANIFESTS.md @@ -35,7 +35,7 @@ You should take a look at our [v1.0 manifest specification](https://github.com/m The multi-file manifest is the preferred method for building manifests. The mimimum required files are a [version](doc/manifest/schema/1.0.0/version.md) file, a [defaultLocale](doc/manifest/schema/1.0.0/defaultLocale.md) file and an [installer](doc/manifest/schema/1.0.0/installer.md) file. ## Creating your first manifest -Once you have 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. +Once you have 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). ### How do I install Winget-Create? diff --git a/README.md b/README.md index e8f27c743ea4c..a3f50abb9175f 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,14 @@ To submit a package to this repository, you should follow these steps: ## Authoring a Manifest -You may either use the [Windows Package Manager Manifest Creator](https://github.com/microsoft/winget-create), the [YAMLCreate](#using-the-yamlcreateps1) PowerShell script, or you can craft a manifest manually following our [authoring guidelines](AUTHORING_MANIFESTS.md). +You may either use the [Windows Package Manager Manifest Creator](https://github.com/microsoft/winget-create), the [YamlCreate](#using-the-yamlcreateps1) PowerShell script, or you can craft a manifest manually following our [authoring guidelines](AUTHORING_MANIFESTS.md). > Note: Only one manifest may be submitted per PR. -### Using the YAMLCreate.ps1 -To help author manifest files, we have provided a YAMLCreate.ps1 [powershell script](Tools/YamlCreate.ps1) located in the Tools folder. The script will prompt you for the URL to the installer, then will prompt you to fill in metadata. +### Using the YamlCreate.ps1 +To help author manifest files, we have provided a YamlCreate.ps1 [powershell script](Tools/YamlCreate.ps1) located in the Tools folder. The script will prompt you for the URL to the installer, then will prompt you to fill in metadata. Additional information regarding the YamlCreate script can be found in the [documentation for the script](doc/tools/YamlCreate.md). -> You can use the script by cloning the repository on your PC and run the script directly from the **Tools** folder. +> You can use the script by cloning the repository on your PC and running- the script directly from the **Tools** folder. ## Test your manifest Now that you have authored your manifest, you should make sure it works as expected.