Skip to content

Commit

Permalink
docs: update release template and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bastimeyer committed Oct 9, 2024
1 parent e9494bd commit f9140db
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
25 changes: 11 additions & 14 deletions .github/release-body.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
## 📦 Release contents

Windows installers and Windows portable archives for [Streamlink](https://github.com/streamlink/streamlink), which contain

- an embedded Python environment
- Streamlink and its dependencies
- FFmpeg, required for muxing streams

Please see the [README.md](https://github.com/streamlink/windows-builds#notes) about the differences between the installers and portable archives.

For more information, please see Streamlink's [install docs](https://streamlink.github.io/install.html#windows-binaries).

## 📝 Changelog

- [streamlink/streamlink](https://github.com/streamlink/streamlink/releases) (release changelog)
- [streamlink/windows-builds](https://github.com/streamlink/windows-builds/blob/master/CHANGELOG.md) (packaging changelog)

## ⚙️ How to use
> [!IMPORTANT]
> Streamlink `7.0.0` changes:
> - ⚠️ Support for Python 3.8 and Windows 7/8 systems has ended.
> - ⚠️ No more `x86` ("32 bit") builds.
> Please note that the `x86_64`-installer's default location differs from `x86`.
> Users of non-`x86_64` systems can always build Streamlink+dependencies on their own.
## ⚙️ Instructions

See the [README.md](https://github.com/streamlink/windows-builds#notes) for all the details about the installers and portable archives.

See the detailed [CLI guide](https://streamlink.github.io/cli.html) on Streamlink's website.
Further information can be found in Streamlink's [install docs](https://streamlink.github.io/install.html) and [Command-Line Interface usage guide](https://streamlink.github.io/cli.html).

## ❤️ Support

Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ Please see [Streamlink's install documentation](https://streamlink.github.io/ins

The windows-builds changelog can be found [here](https://github.com/streamlink/windows-builds/blob/master/CHANGELOG.md).

> [!IMPORTANT]
> Streamlink `7.0.0` changes:
> - ⚠️ Support for Python 3.8 and Windows 7/8 systems has ended.
> - ⚠️ No more `x86` ("32 bit") builds.
> Please note that the `x86_64`-installer's default location differs from `x86`.
> Users of non-`x86_64` systems can always build Streamlink+dependencies on their own.

## Contents

Expand Down

0 comments on commit f9140db

Please sign in to comment.