Update README with generated table #64
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greg-fer
requested changes
Jan 23, 2025
| * `releases` are the add-on versions. | ||
| | Property | Requirement | Description | | ||
| | -------- | ------------ | ----------- | | ||
| | name | Required | The name of the application repo. Should be the repo-name in the GitHub URL: https://github.com/org/repo-name.| |
There was a problem hiding this comment.
Suggested change
| | name | Required | The name of the application repo. Should be the repo-name in the GitHub URL: https://github.com/org/repo-name.| | |
| | name | Required | The name of the application repository. Should be the `repo-name` in the GitHub URL: https://github.com/org/repo-name.| |
| | Property | Requirement | Description | | ||
| | -------- | ------------ | ----------- | | ||
| | name | Required | The name of the application repo. Should be the repo-name in the GitHub URL: https://github.com/org/repo-name.| | ||
| | kind | Required | The type of the app repo.| |
There was a problem hiding this comment.
Suggested change
| | kind | Required | The type of the app repo.| | |
| | kind | Required | The type of the application repository.| |
| | kind | Required | The type of the app repo.| | ||
| | tags | Required | An array of tags describing the application.| | ||
| | releases | Required | The collection of project`s releases.| | ||
| | title | Optional | Human readable name of the repo to be shown in the UI. Defaults to the name property.| |
There was a problem hiding this comment.
Suggested change
| | title | Optional | Human readable name of the repo to be shown in the UI. Defaults to the name property.| | |
| | title | Optional | Human-readable name of the repository to be shown in the UI. Defaults to the name property.| |
| | tags | Required | An array of tags describing the application.| | ||
| | releases | Required | The collection of project`s releases.| | ||
| | title | Optional | Human readable name of the repo to be shown in the UI. Defaults to the name property.| | ||
| | description | Optional | Text describing the application. Inferred from the repo if missing.| |
There was a problem hiding this comment.
Suggested change
| | description | Optional | Text describing the application. Inferred from the repo if missing.| | |
| | description | Optional | Text describing the application. If missing, it is inferred from the repository.| |
| | releases | Required | The collection of project`s releases.| | ||
| | title | Optional | Human readable name of the repo to be shown in the UI. Defaults to the name property.| | ||
| | description | Optional | Text describing the application. Inferred from the repo if missing.| | ||
| | manifest | Optional | Alternative filename for the west manifest. Defaults to west.yml.| |
There was a problem hiding this comment.
Suggested change
| | manifest | Optional | Alternative filename for the west manifest. Defaults to west.yml.| | |
| | manifest | Optional | Alternative file name for the west manifest. Defaults to `west.yml`.| |
| | title | Optional | Human readable name of the repo to be shown in the UI. Defaults to the name property.| | ||
| | description | Optional | Text describing the application. Inferred from the repo if missing.| | ||
| | manifest | Optional | Alternative filename for the west manifest. Defaults to west.yml.| | ||
| | license | Optional | The name of the application license, e.g. "Apache 2.0". Inferred from the repo if missing.| |
There was a problem hiding this comment.
Suggested change
| | license | Optional | The name of the application license, e.g. "Apache 2.0". Inferred from the repo if missing.| | |
| | license | Optional | The name of the application license, for example "Apache 2.0". If missing, it is inferred from the repository.| |
| | description | Optional | Text describing the application. Inferred from the repo if missing.| | ||
| | manifest | Optional | Alternative filename for the west manifest. Defaults to west.yml.| | ||
| | license | Optional | The name of the application license, e.g. "Apache 2.0". Inferred from the repo if missing.| | ||
| | apps | Optional | Glob pattern to find directories containing applications.Applications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.By default, the VS Code extension will assume that there's just a single application sitting at the root of the repo.| |
There was a problem hiding this comment.
Suggested change
| | apps | Optional | Glob pattern to find directories containing applications.Applications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.By default, the VS Code extension will assume that there's just a single application sitting at the root of the repo.| | |
| | apps | Optional | Glob pattern to find directories containing applications. Applications need a `*.conf` file and the `CMakeLists.txt` file at their root. The glob expressions are used to match directories, so no file pattern is necessary. By default, the nRF Connect for Visual Studio Code extension will assume that there is just a single application sitting at the root of the repository.| |
| | manifest | Optional | Alternative filename for the west manifest. Defaults to west.yml.| | ||
| | license | Optional | The name of the application license, e.g. "Apache 2.0". Inferred from the repo if missing.| | ||
| | apps | Optional | Glob pattern to find directories containing applications.Applications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.By default, the VS Code extension will assume that there's just a single application sitting at the root of the repo.| | ||
| | defaultBranch | Optional | The default git branch that the repository is checked out. Inferred from the repo if missing.| |
There was a problem hiding this comment.
Suggested change
| | defaultBranch | Optional | The default git branch that the repository is checked out. Inferred from the repo if missing.| | |
| | defaultBranch | Optional | The default git branch that the repository is checked out at. If missing, it is inferred from the repository.| |
| | license | Optional | The name of the application license, e.g. "Apache 2.0". Inferred from the repo if missing.| | ||
| | apps | Optional | Glob pattern to find directories containing applications.Applications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.By default, the VS Code extension will assume that there's just a single application sitting at the root of the repo.| | ||
| | defaultBranch | Optional | The default git branch that the repository is checked out. Inferred from the repo if missing.| | ||
| | docsUrl | Optional | The URL of the add-on's documentation| |
There was a problem hiding this comment.
Suggested change
| | docsUrl | Optional | The URL of the add-on's documentation| | |
| | docsUrl | Optional | The URL of the add-on's documentation.| |
| | apps | Optional | Glob pattern to find directories containing applications.Applications need a *.conf file and a CMakeLists.txt file at their root. The glob expressions are used to match directories, so no file pattern is necessary.By default, the VS Code extension will assume that there's just a single application sitting at the root of the repo.| | ||
| | defaultBranch | Optional | The default git branch that the repository is checked out. Inferred from the repo if missing.| | ||
| | docsUrl | Optional | The URL of the add-on's documentation| | ||
| | restricted | Optional | Mark the restricted access to any of the dependencies.| |
There was a problem hiding this comment.
Suggested change
| | restricted | Optional | Mark the restricted access to any of the dependencies.| | |
| | restricted | Optional | Check for marking the restricted access to any of the dependencies.| |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a script that generates markdown table based on the contributors index schema. The script outputs the table to the console. The content has to be manually copied into the README.md.