Skip to content
This repository has been archived by the owner on Nov 19, 2020. It is now read-only.

Latest commit

 

History

History
56 lines (28 loc) · 3.42 KB

README.md

File metadata and controls

56 lines (28 loc) · 3.42 KB
Raw

STEP 1 - Get the machinery running ⚙️

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_BOT and the value must be the key you obtained from the previous step.

Push a dummy change to the master

📤

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 master branch, visit the Actions tab of your repository. You should see an action named Build proceeding PDF, which consists of two steps 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! At this stage, it should be identical to the BrainHack proceedings template webpage.

Unless you change the name of the repo you forked from template to something else, your page will be published at your_GitHub_handle.github.io/template.

STEP 2 - 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.

⚠️ Warning
Please do not change the name or the location of report.md and report.bib. Unless you provide an absolute path for your figures, they will be looked for in the figures folder.

Whenever you push your changes to the master 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.