Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 2.83 KB

README.md

File metadata and controls

42 lines (23 loc) · 2.83 KB

Culhane lab website

This GitHub repository is for the Culhane laboratory at the University of Limerick School of Medicine, led by Dr. Aedin Culhane. You can view this webpage live at: INSERT WEBSITE.

Installation

This website is powered by quatro.

System requirements

To launch this website, you must have the following set up on your system, - Quatro, which can be installed for Linux, Mac OS, or Windows from the quatro Get Started webpage. - An editor to use with quatro such as RStudio, Jupyter, VS Code, or Terminal.

Download this repository from GitHub

This package can be downloaded through GitHub on the website or by using terminal. To download on the website, navigate to the top of this page, click the green Code button, and select Download ZIP. This will download this repository in a compressed format. Extract the compressed directory within your desired parent directory.

To install using GitHub on terminal, type the following into terminal when located in your desired parent directory,

git clone https://github.com/CompOnco/lab_website.git
cd lab_website

Contributing to this repository

Changes made can be added to this repository using the git commit command with GitHub. This can be performed either on the main branch or on a separate branch, followed by a Pull Request before merging.

Alternatively, specific files can be edited in browser on GitHub.com. The changes will be committed to a new branch and open a new pull request.

Previewing locally

Quarto has extensive documentation on how to develop websites using the platform. Websites can be previewed by typing the following into terminal from project folder,

quatro preview 

Using Markdown

Quatro makes extensive use of Markdown, a plain text format that is designed to be easy to read and write. Their website has a markdown basics page that may be helpful when editing this website.