forked from hacs/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
id: netdaemon | ||
title: NetDaemon Apps | ||
description: "NetDaemon Apps" | ||
--- | ||
|
||
A template to use as a reference is [netdaemon-app-template](https://github.com/helto4real/netdaemon-app-template) | ||
|
||
## Requirements | ||
|
||
For a NetDaemon app repository to be valid these are the requirements: | ||
|
||
### Repository structure | ||
|
||
- There is only one app (one directory under `ROOT_OF_THE_REPO/apps/`) pr. repository (if you have more, only the first one will be managed.) | ||
- The app (all the python files for it) are located under `ROOT_OF_THE_REPO/apps/APP_NAME/` | ||
- The app and all the python files for it are located under `ROOT_OF_THE_REPO/apps/APP_NAME/` | ||
|
||
#### OK example: | ||
|
||
```text | ||
apps/awesome/awesome.cs | ||
info.md | ||
README.md | ||
``` | ||
|
||
#### Not OK example (1): | ||
|
||
```text | ||
awesome/awesome.cs | ||
info.md | ||
README.md | ||
``` | ||
|
||
#### Not OK example (2): | ||
|
||
```text | ||
awesome.cs | ||
info.md | ||
README.md | ||
``` | ||
|
||
### GitHub releases (optional) | ||
|
||
#### If there are releases | ||
|
||
When installing/upgrading it will scan the content in the latest release. | ||
|
||
If there are multiple releases in the repository the user have some options to install a specific version. | ||
The choices will be the last 5 releases and the default branch. | ||
|
||
#### If there are no releases | ||
|
||
It will scan files in the branch marked as default. |
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