Update README.md (#105)
* Update README.md * Update README.md Co-authored-by: Kevin Larkin (MS) <kevinla@microsoft.com>
This commit is contained in:
27
README.md
27
README.md
@@ -1,3 +1,26 @@
|
||||
# Authoring a Manifest
|
||||
|
||||
The minimal manifest syntax is below.
|
||||
|
||||
Current limitations are:
|
||||
* One manifest per PR
|
||||
* One installer per PR
|
||||
|
||||
Be sure the manifest filename matches the `Version` and the manifest is located in the folder path matching `manifests\<publisher>\<package>\<version>.yaml`
|
||||
|
||||
```yaml
|
||||
Id: string # publisher.package format
|
||||
Publisher: string # the name of the publisher
|
||||
Name: string # the name of the application
|
||||
Version: string # version numbering format
|
||||
License: string # the open source license or copyright
|
||||
InstallerType: string # enumeration of supported installer types (exe, msi, msix)
|
||||
Installers:
|
||||
- Arch: string # enumeration of supported architectures
|
||||
URL: string # path to download installation file
|
||||
Sha256: string # SHA256 calculated from installer
|
||||
# ManifestVersion: 0.1.0
|
||||
```
|
||||
|
||||
# Contributing
|
||||
|
||||
@@ -12,3 +35,7 @@ provided by the bot. You will only need to do this once across all repos using o
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
For the avoidance of doubt, you may not make any Submissions linking to third party materials if such
|
||||
Submission is prohibited by the applicable third party and/or otherwise violates such third party's rights.
|
||||
|
||||
|
Reference in New Issue
Block a user