Every tutorial should be uploaded to a GitHub repository and should be a standalone unit. That is, the GitHub repository should contain, besides the tutorial itself,
- All data files used in the tutorial
- Example BEAST2 XML files
- Example output files from running the XML files in BEAST2
- Any scripts needed for pre- or post-processing
Keep in mind that the name of the tutorial displayed on the website will be the name of the GitHub repository, with all hyphens replaced with spaces. Please choose an explanatory name that properly identifies your tutorial! There is no need to use abbreviations to keep tutorial names short.
We have created a tutorial template repository to help you get started. The easiest way to create a new tutorial is to simply clone the template (or any of the existing tutorials). This will set up the correct directory structure for the tutorial. Follow these steps:
- Create a GitHub account (if you don’t already have one)
- Create a new repository on your GitHub account with the name of your tutorial. Let’s assume for the rest of this example that your tutorial will be called My-Awesome-Tutorial. Do not initialize the repository with a README and do not add a
- Navigate to where you want to create the tutorial
git clone email@example.com:Taming-the-BEAST/Tutorial-Template.git
(Note: This is the template tutorial, not the tutorial you just created on your GitHub account)
- Rename the directory to the new tutorial’s name:
mv Tutorial-Template My-Awesome-Tutorial(this step is optional, but keeps everything nice and tidy)
- Enter the tutorial directory:
- Change the origin of the repository so it points to the newly created repository on your GitHub account:
git remote set-url origin firstname.lastname@example.org:<your-username>/My-Awesome-Tutorial.git
git push -u origin master
Alternatively, it is also possible to create a blank repository and set up the same directory structure. The default structure of a tutorial is:
. ├── data/ | └── (alignment files) ├── xml/ | └── (BEAST2 XML files) ├── precooked-runs/ | └── (.log and .trees files from BEAST output) ├── scripts/ | └── (pre- and post-processing scripts) ├── figures/ | └── (screenshots and other figures used in the tutorial) ├── README.md ├── biblatex_macros.tex ├── main.tex └── preamble.tex
.tex files are optional and are used for tutorials written in LaTeX. If you do not want to include a LaTeX version of the tutorial, be sure to remove
main.tex from the repository.
If you want to add any further documentation or lecture slides to the tutorial, either add them to the root of the tutorial or to a directory with a descriptive name. All PDF files will be automatically detected and available to view or download from the website.