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

Fix: README.md: change binary download instructions #851

Merged
merged 1 commit into from
May 3, 2023

Conversation

madmartin
Copy link
Contributor

new download instructions since github releases are on the project homepage

@madmartin
Copy link
Contributor Author

@tbnobody the fix in the readme is important since that also confuses OpenDTU-onBattery users - see hoylabs#186

README.md Outdated
@@ -210,8 +210,7 @@ It is recommended to make all changes only in the 'platformio_override.ini', th

### using the pre-compiled .bin files

The pre-compiled files can be found on the [github page](https://github.com/tbnobody/OpenDTU) in the tab "Actions" and the sub menu "OpenDTU Build". Just choose the latest build from the master branch (search for "master" in the blue font text but click on the white header text!). You need to be logged in with your github account to download the files.
Use a ESP32 flash tool of your choice (see next chapter) and flash the `.bin` files to the right addresses:
The pre-compiled binary files can be found here on the [github page behind "Releases"](./releases/:) (look at the right column). For a first installation on an ESP32, download `opendtu-generic.zip`, unpack and use a ESP32 flash tool of your choice (see next chapter) to flash the `.bin` files to the right addresses:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This relative link will not work. If a user is e.g. on a tag (e.g. https://github.com/tbnobody/OpenDTU/tree/v23.4.17) it will point to https://github.com/tbnobody/OpenDTU/tree/v23.4.17/releases which will give a 404

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expected that to work (except for the colon at the end of the link, this is definitely a mistake...).
Okay, if in doubt we use a complete URL for the link.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, but that could be avoided by referring to a static page:
https://github.com/tbnobody/OpenDTU/releases

new download instructions since github releases are on the project homepage

Signed-off-by: Martin Dummer <martin.dummer@gmx.net>
@madmartin madmartin requested a review from tbnobody April 28, 2023 20:48
@tbnobody tbnobody merged commit 71c937c into tbnobody:master May 3, 2023
Copy link

github-actions bot commented Apr 5, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants