Skip to content

Commit 88d9c97

Browse files
committed
docs(readme/index): consistent
1 parent c09703b commit 88d9c97

File tree

2 files changed

+26
-5
lines changed

2 files changed

+26
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
# quarto-tutorial
1+
# Beginner-friendly tutorial on using Quarto for sharing research
2+
23
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
34
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
45
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5-
Beginner-friendly tutorial on using Quarto for sharing research.
66

7-
## Contributors ✨
7+
In this hands-on workshop, you'll learn how to build a straightforward Quarto website to share and organise your research. You will be introduced to using GitHub, Quarto and Markdown. No prior experience is needed - we'll guide you through each step using free, open tools that make it quick and straightforward to get a site online.
8+
9+
You'll see how a website can become a powerful hub for your work: a place to share notes, methods, outputs, and updates openly and accessibly. Your site could act as a:
10+
11+
* A homepage that brings together work across a theme, programme, or research area.
12+
* A project site focused on a single study, collecting all results, any code, and outputs, and acting like an online appendix to a paper.
13+
14+
The workshop will give you **practical skills and templates you can adapt for your own research**. By the end, you'll have the foundations for your own site - and a clear sense of how open, well-documented work can make your research easier to share, reuse, and build on.
15+
16+
After the workshop, you can keep building on your site. Quarto has many possibilities, including adding blog posts, interactive figures, embedded code, galleries, teaching materials, or project updates. It's a flexible foundation that can grow with your research, learning, and collaborations - and is free and open to use and host your site.
817

9-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
18+
## Contributors
1019

1120
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
1221
<!-- prettier-ignore-start -->
@@ -25,4 +34,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
2534

2635
<!-- ALL-CONTRIBUTORS-LIST:END -->
2736

28-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
37+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
38+
39+
## Funding
40+
41+
This course was developed as part of the [STARS project](https://pythonhealthdatascience.github.io/stars/). STARS is supported by the Medical Research Council [grant number MR/Z503915/1].
42+
43+
The in-person workshop was supported by departmental funding for activities aiming to enhance research culture in the **Department of Health and Community Sciences** at the University of Exeter.
44+
45+
![Sharing Tools and Artefacts for Reproducible & Reusable Simulations in healthcare](images/stars_reproduce_reuse_banner_blue.png)

index.qmd

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,12 @@ After the workshop, you can keep building on your site. Quarto has many possibil
3434

3535
<!-- ALL-CONTRIBUTORS-LIST:END -->
3636

37+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
38+
3739
## Funding
3840

3941
This course was developed as part of the [STARS project](https://pythonhealthdatascience.github.io/stars/). STARS is supported by the Medical Research Council [grant number MR/Z503915/1].
4042

43+
The in-person workshop was supported by departmental funding for activities aiming to enhance research culture in the **Department of Health and Community Sciences** at the University of Exeter.
44+
4145
![](images/stars_reproduce_reuse_banner_blue.png){fig-alt="Sharing Tools and Artefacts for Reproducible & Reusable Simulations in healthcare"}

0 commit comments

Comments
 (0)