Skip to content

Commit

Permalink
Clarify authoring changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sajith committed Apr 7, 2024
1 parent 10fbd10 commit 2ddb211
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ See [index] for an outline of the course material.

## Authoring content

The content in this repository is processed using [Quarto] in order to
The content in this repository is written in the form of markdown
files or Jupyter notebooks, and processed using [Quarto] in order to
generate the website seen at https://xcitecourse.org/.

To add content, do this:
To add/update content, do this:

- Download and install Quarto from [quarto.org][Quarto].
- Clone this repository.
- Clone/fork this repository.
- Add/edit content in the form of `.md`, `.qmd`, or `.ipynb` files.
- Open a terminal, and run `quarto preview`, which will start a local
webserver with a live preview.
- Run `quarto preview` in a terminal, which will start a local web
server with a live preview that opens in your web browser.
- Once you are satisfied with your changes, commit them, and push them
to this repository, or submit a pull request.

Expand Down

0 comments on commit 2ddb211

Please sign in to comment.