search

FelixBaensch / MORTAR

MOlecule fRagmenTAtion fRamework
MIT License
18 stars 3 forks source link

Activate GitHub pages for this repo, building from branch "gh-pages" #20

Closed JonasSchaub closed 6 months ago

JonasSchaub commented 8 months ago

We can use the readme as landing page and put the tutorial there. Even more tutorials or documentation material in the future.

I have started the gh-pages branch from the current master commit now (instead of an orphan branch, which would be best practice). So, we have to think about what to remove from this branch. But I first wanted to have a look at how the different files are displayed in this environment.

FelixBaensch commented 6 months ago

What should/can I do here?

JonasSchaub commented 6 months ago

You have to go to Settings -> Pages -> Source: Deploy from branch -> branch: gh-pages /(root) -> Save

Then GitHub should build a website from the repo. I will then clean it up.

FelixBaensch commented 6 months ago

Thank you, I didn't realize that I had to do that, I thought you were allowed to do that too. Btw.: Done https://felixbaensch.github.io/MORTAR/

JonasSchaub commented 6 months ago

I thought you were allowed to do that too.

Sadly, no...

Btw.: Done

Thanks, I will look at it and improve it a bit.

JonasSchaub commented 6 months ago

Done, stripped all unnecessary files from the gh-pages branch, fixed the logo, added link to online version of tutorial PDF document: https://felixbaensch.github.io/MORTAR/