format for github

README.md

@@ -0,0 +1,83 @@
+# Setup Instructions for Insight Net Workshop 2024
+
+
+Welcome to the Insight Net Workshop 2024 Github Repository. We’ve made
+it easy for you to get started with this project, and we’re happy to
+help! Please take your time and follow the steps below. If you encounter
+any issues or need extra help, feel free to reach out–our volunteers are
+available to assist during setup and throughout the workshop.
+
+## 1. **Download the Repository (For Beginners)**
+
+If you’re new to GitHub or prefer not to use command-line tools, the
+easiest way to get started is by downloading the repository as a ZIP
+file.
+
+### Steps:
+
+1.  On the [InsightNet Workshop 2024 GitHub
+    repository](https://github.com/cmu-delphi/insightnet-workshop-2024).
+2.  Click the green **Code** button located at the top right of this
+    repository.
+3.  In the dropdown menu, select **Download ZIP**.
+4.  Once downloaded, extract the ZIP file to a folder on your local
+    machine.
+5.  Open the extracted folder, and you’re all set!
+
+You can now open the project files locally and start working with them.
+
+------------------------------------------------------------------------
+
+## 2. **Clone or Fork the Repository (For Advanced Users)**
+
+If you’re familiar with Git, cloning or forking the repository is a more
+flexible option. This will allow you to stay up to date with the latest
+changes and contribute to the project directly.
+
+<!-- Cloning: You get a local copy of the repository (on your computer), but you're working directly with the original repo. If you want to contribute to the original, you'll either need write access or need to fork it.
+Forking: You get a personal copy of the repository on GitHub under your account, and you have full control over this copy. From there, you can create a pull request to propose changes back to the original repo.
+-->
+
+### **Cloning the Repo**:
+
+<!-- You'll get a local copy of the repository. -->
+
+1.  Open a terminal or command prompt on your computer.
+2.  Navigate to the folder where you want to store the project.
+3.  Run the following command:
+
+``` bash
+git clone https://github.com/cmu-delphi/insightnet-workshop-2024.git
+```
+
+Once cloning is complete, navigate into the project folder:
+
+``` bash
+cd insightnet-workshop-2024
+```
+
+### **Forking the Repo**:
+
+1.  In the top right corner of this Github repository, click the Fork
+    button.
+2.  Once the repository is forked, you can either:
+    - **Clone** your forked version to your local machine by using
+      GitHub Desktop or the terminal:
+
+    ``` bash
+      git clone https://github.com/your-username/insightnet-workshop-2024.git
+    ```
+
+    - Alternatively, you can download it as a ZIP file by clicking
+      **Code** –\> **Download ZIP** on your forked repository page.
+3.  After cloning or downloading, navigate into the project folder:
+
+``` bash
+   cd insightnet-workshop-2024
+```
+
+### **Get Help from Our Volunteers:**
+
+If you encounter any issues or would like assistance with setting things
+up, don’t hesitate to reach out. We have a fantastic group of volunteers
+available who can help guide you through the process.

README.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Setup Instructions for Insight Net Workshop 2024"
+format: gfm
 ---
 
 Welcome to the Insight Net Workshop 2024 Github Repository. We've made it easy for you to get started with this project, and we're happy to help! Please take your time and follow the steps below. If you encounter any issues or need extra help, feel free to reach out--our volunteers are available to assist during setup and throughout the workshop.