Releases contain (half-done) README.md
broesamle opened this issue · 0 comments
broesamle commented
There are separate commits for changes on code and changes on the README.md. But they are on the same branch in a mixed fasion:
CODE
README
CODE
CODE <--------tag/release
README
If you download a snapshot (release / tag) it will also contain a snapshot of the (unfinished) readme :-(
To sort this out:
- replay the code-related commits on a new branch (one for each example); separate from the instructions referring to the snapshots
- put a tag/release on each snapshot
- update the links in the
[Snapshot]sections in the readme.
ALTERNATIVELY:
Just keep it as it is but do not link to the download section, but to the relevant raw source file.
I think i like this more :)
or even like this