A website to host documentation relating to the ReModel: Read, Run, Reuse Open Simulation Models project.
- Ensure that you have Quarto installed on your machine
- Clone this repository to your local machine
- Checkout the main branch and ensure it is up to date with
git checkout main && git pullin the terminal - Checkout a new branch
git checkout -b your-branch-name - Make your edits in your branch and save your file. For the sessions, you will need to create new folders for each session, with an index.qmd within it. It's probably easiest to copy and paste from a previous session.
- Preview your changes with
quarto preview .in the terminal - your browser should open showing you what your changes will look like - When you're happy, add and commit your changes with
git add files/to/addandgit commit -m "message about your commit" - Push your changes to your branch on GitHub with
git push origin your-branch-name - Make a pull request and wait for your changes to be approved.
- When your pull request is approved, merge it into the
mainbranch.
The website will automatically be updated via GitHub actions whenever changes are merged into the main branch.