Skip to content

Commit

Permalink
docs(preamble): 📝 add the assumptions and "who you are" section
Browse files Browse the repository at this point in the history
Closes #3 and closes #11
  • Loading branch information
lwjohnst86 committed Jan 17, 2025
1 parent a93e508 commit 4bd8489
Showing 1 changed file with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,36 @@ Objectives:

- Item 1

## Is this course for you? {#sec-is-it-for-you}

To help manage expectations and develop the material for this course, we
make a few assumptions about *who you are* as a participant in the
course:

- Assumptions
## Is this for you? {#sec-is-it-for-you}

To help manage expectations and develop the material for this tutorial,
we make a few possible assumptions about *who you are* as a participant
in the tutorial, such as one or more of the following:

- You want a gentle introduction to what GitHub is and how to use it.
- You mostly work alone or maybe irregularly with someone else on your
project.
- You are assigned tasks on a project that others are also involved
in, but the tasks don't overlap with others, require direct
contributions from others, or don't share the same files as others.
- You write text in documents as a main activity of your work.
- You are able to and are comfortable enough to only work on files
through a web browser interface (like GitHub's interface).

While we have these assumptions to help focus the content of the course,
if you have an interest in learning R but don't fit any of the above
assumptions, *you are still welcome to attend the course*! We welcome
everyone, that is until the course capacity is reached.
if you have an interest in the tutorial but don't fit any of the
assumptions, *you are still welcome to attend the tutorial*! We welcome
everyone, that is until capacity has been reached.

In addition to the assumptions, we also have a fairly focused scope for
teaching and expectations for learning. So this may also help you decide
if this course is for you.

- List of what we will teach and won't teach
- We will only interact with GitHub from the website and from a web
browser.
- We will only write *text*, there will be no code or programming
used.
- While we will write in a `.md` Markdown file, we will not write or
cover Markdown syntax.
- We will not go over too many details of Git (a software that GitHub
relies on).

0 comments on commit 4bd8489

Please sign in to comment.