Skip to content

Commit

Permalink
Standardize whitespace in Authoring.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Trenly committed Mar 15, 2024
1 parent f5350de commit d6cf4d7
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/Authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,23 @@ 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
If you are authoring a manifest yourself one of the imporant things to note related to installer types is architecture. In many cases the installer itself may be an x86 installer, but it will actually install the package for the architecture of the system. In these cases, the installer type in the manifest should target the architecture of the system it will be installed on. So in some cases the actual installer itself targets x86, but in fact it will install an x64 version of the package.


### 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
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
Expand All @@ -64,13 +67,15 @@ 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
winget validate --manifest <Path to 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
Expand Down

0 comments on commit d6cf4d7

Please sign in to comment.