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.

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

Update the release script with installation instructions as well as opencollective #1471

Closed
cdrage opened this issue Feb 5, 2018 · 7 comments
Assignees

Comments

@cdrage
Copy link
Contributor

cdrage commented Feb 5, 2018

TODO for me (so I don't forget):

  • Update release script with installation instructions (release notes)
  • Add OpenCollective links
@cdrage cdrage self-assigned this Feb 5, 2018
cdrage added a commit to cdrage/streamlink that referenced this issue Apr 18, 2018
Updates the release script to include installation instructions.

Closes streamlink#1471
@back-to
Copy link
Collaborator

back-to commented May 8, 2018

reopen

# Installation
**Installing with Pip:**
\`\`\`sh
sudo pip install streamlink
\`\`\`
**Manual installation:**
\`\`\`sh
curl -L https://github.com/streamlink/streamlink/releases/download/$2/streamlink-$2.tar.gz -O streamlink.tar.gz
tar xvf streamlink.tar.gz
cd streamlink
sudo python setup.py install
\`\`\`
# Supporting Streamlink

markdown doesn't work for https://streamlink.github.io/changelog.html

@back-to back-to reopened this May 8, 2018
@beardypig
Copy link
Member

Should probably switch everything to rST :)

@cdrage
Copy link
Contributor Author

cdrage commented May 8, 2018

@beardypig @back-to thanks for catching on, I'm so used to writing in markdown.. I'll switch it to RST in a separate PR 👍

@beardypig
Copy link
Member

The problem is the releases page doesn't seem to support rST :(

@bastimeyer
Copy link
Member

Can't we just add another parser for markdown to the sphinx/docutils config?
https://github.com/rtfd/recommonmark

@beardypig
Copy link
Member

Yep, I was looking in to that too. There are some things we could improve in the release process, I was going to create an issue with some suggestions :)

@back-to
Copy link
Collaborator

back-to commented May 29, 2018

https://streamlink.github.io/changelog.html is fixed in #1667

@back-to back-to closed this as completed May 29, 2018
mkbloke pushed a commit to mkbloke/streamlink that referenced this issue Aug 18, 2020
Updates the release script to include installation instructions.

Closes streamlink#1471
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants