search

yannikschaelte / MiniPlaner

Software zum automatischen Erstellen von Messdienerplänen.
https://yannikschaelte.github.io/MiniPlaner
GNU Lesser General Public License v3.0
4 stars 2 forks source link

Separate Repository from Website #34

Closed mkroening closed 4 years ago

mkroening commented 4 years ago

I think we should separate the user experience from the developer experience.

Currently, yannikschaelte.github.io/MiniPlaner is generated from master. We can use a gh-pages branch for the website [1] and generate the website via an index.md file [2].

That way we can rewrite README.md to house relevant information about building the program, which are irrelevant to the end user and preferably written in English.

Furthermore, we should exclude binaries from the source tree. Things currently listed in "Download" and "Beispiel" in README.md should be added to the corresponding release: MiniPlaner/v2.0.4

@yannikschaelte, what do you think?

[1] Configuring a publishing source for your GitHub Pages site - GitHub Help [2] Creating a GitHub Pages site - GitHub Help

yannikschaelte commented 4 years ago

I fully agree here. Distributing binaries via releases definitely makes more sense, here they were just uploaded as part of the repo in the first place, but that was admittedly not super tidy.

mkroening commented 4 years ago

I don't have the necessary rights to change the branch, the website is being generated from. @yannikschaelte, could you take care of this?

I edited the 2.0.4 release to contain the binaries. I omitted the 7z variants of the archives, is that okay?

Once the website is based of the new branch, we can provide the downloads via the releases section instead of the repository itself.

yannikschaelte commented 4 years ago

changed pages source to gh-pages. It is totally fine to omit the 7z archives.

yannikschaelte commented 4 years ago

Should now be online on https://yannikschaelte.github.io/MiniPlaner. I also changed the download targets to the release. Anything missing?