Use this template

🍪✂️

Click the green Use this template button and create a repository in your own user account.

Please follow YYYY_MM_first-auth-surname_freeform-keywords convention to name your repository.

For example: 2020_10_karakuzu_qmri-pulse-sequence

Create a GitHub access token

🔑

Follow these steps and make sure that you check the repo, admin:repo_hook and workflow boxes while creating your access token.

Create an encrypted secret for your repo

🕵️‍♀️

Simply follow these steps.

The name of the secret must be PAT_BHP and the value must be the key you obtained from the previous step.

Push a dummy change to the main

📤

It can be anything, such as simply editing this README.md file you are reading at the moment.

What now ?

👀

After pushing your changes to the main branch, visit the Actions tab of your repository. You should see an action named Report, which consists of three jobs: updateInfo , buildPDF and buildHugo.

Soon after a successful action run, your web page will be deployed. You should see Environments section appeared in your repository (on the right column). In the Environments page, click the View Deployment button to visit your report page!

Edit your report ✍️

• Place your figures in the figures folder.

• Edit report.md file to create your own report. The template markdown will walk you through how to cite references, add figures and equations etc.

• Edit report.bib to add your bibliography in BibTeX format.

• To adjust the size and the appearence of your figures on the corresponging web-page, please edit figures/figures.css file. You can find the instructions in the file.

⚠️ Warning
Please do not change the name or the location of report.md and report.bib.

Note
Your figures are expected to be located in the figures folder. This is strictly by design.

Whenever you push your changes to the main branch (either directly or via merging a branch), GitHub actions will be triggered to update your report. That's it!

If actions run completes successfully, 🟠 (running) will turn into ✅ (success). If your build fails, you will see ❌ instead. In that case, you can read the logs to see what went wrong.

If you don't want to trigger a workflow run after pushing a commit to the main branch, please pass skip workflow as the commit message.

Wiki Page

See a list of potential problems and their solutions at the wiki page.