Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove references to info.md and render_readme #560

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Remove references to info.md and render_readme #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
163c84f
Remove refrences to info.md and render_readme
ludeeus Aug 22, 2024
eda1be2
Merge branch 'main' into remove-info
ludeeus Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions source/docs/publish/appdaemon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,20 @@ For an AppDaemon app repository to be valid these are the requirements:

```text
apps/awesome/awesome.py
info.md
README.md
```

#### Not OK example (1):

```text
awesome/awesome.py
info.md
README.md
```

#### Not OK example (2):

```text
awesome.py
info.md
README.md
```

Expand Down
4 changes: 0 additions & 4 deletions source/docs/publish/include.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,6 @@ This checks that the hacs.json file at least contains the following:

https://hacs.xyz/docs/publish/start#hacsjson

### Check Info

This checks that there is an info.md (or readme.md if configured) file with content in the repository.

### Check Archived

This checks if the repository is archived.
Expand Down
3 changes: 0 additions & 3 deletions source/docs/publish/integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ For an integration repository to be valid it must meet the requirements below.
custom_components/awesome/__init_.py
custom_components/awesome/sensor.py
custom_components/awesome/manifest.json
info.md
README.md
```

Expand All @@ -30,7 +29,6 @@ README.md
awesome/__init_.py
awesome/sensor.py
awesome/manifest.json
info.md
README.md
```

Expand All @@ -40,7 +38,6 @@ README.md
__init_.py
sensor.py
manifest.json
info.md
README.md
```

Expand Down
2 changes: 0 additions & 2 deletions source/docs/publish/python_script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,13 @@ For a python_script repository to be valid these are the requirements:

```text
python_scripts/awesome.py
info.md
README.md
```

#### Not OK example:

```text
awesome.py
info.md
README.md
```

Expand Down
7 changes: 1 addition & 6 deletions source/docs/publish/start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ Your repository on GitHub needs to have [topics](https://docs.github.com/en/gith

### README

Your repository needs to have a [readme](https://github.com/matiassingers/awesome-readme) with information about how to use it. _This is not used in HACS, unless you have defined the key `render_readme` in `hacs.json` below._

### info.md

If you want to add a richer experience for your users you can add an `info.md` file to the root of your repository, this file will be rendered under the repository description. It does not support the full styling options from GitHub, so use with care. _This is optional, if you do not have this file you need to set the key [`render_readme`](#hacsjson) in the `hacs.json` file to `true`._
Your repository needs to have a [readme](https://github.com/matiassingers/awesome-readme) with information about how to use it.
ludeeus marked this conversation as resolved.
Show resolved Hide resolved

### hacs.json

Expand All @@ -46,7 +42,6 @@ The following keys are supported:
| `content_in_root` | bool | No | Indicates whether the content is in the root of the repository as opposed to in a subdirectory. |
| `zip_release` | bool | No | Indicates whether the content is in a zipped archive when releases are published on GitHub. If you use this you also need to add `filename`. **This is only supported for integrations.** |
| `filename` | string | No | Name of the file HACS should look for, only applies to single item types (plugin, theme, template, python_scripts, zip_release). |
| `render_readme` | bool | No | Tells HACS to render the README.md file instead of info.md. |
| `hide_default_branch` | bool | No | Tells HACS to not offer downloading the default branch. |
| `country` | string | No | Two character country code in ISO 3166-1 alpha-2 format. [ISO 3166-1 alpha-2 on Wikipedia](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |
| `homeassistant` | string | No | The minimum required Home Assistant version. |
Expand Down
2 changes: 0 additions & 2 deletions source/docs/publish/theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,13 @@ For a theme repository to be valid these are the requirements:

```text
themes/awesome.yaml
info.md
README.md
```

#### Not OK example:

```text
awesome.py
info.md
README.md
```

Expand Down