diff --git a/README.md b/README.md index 3905177..04f53f3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,44 @@ -# React + Vite +# 2024 WICC Workshop -This is a personal website/portfolio template used for WICC 2024 workshop. It's built with [React](https://reactjs.org). +## Table of Contents + +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Getting Started](#getting-started) +- [Contributions](#contributions) +- [License](#usage-and-attribution) + +## Introduction + +This is a personal website/portfolio template used for the WICC 2024 workshop. It's built with [React](https://reactjs.org). You can view the Figma file of this template [here](https://www.figma.com/file/uTyUhNtDpYuW5mKwm6eT2S/Workshop-Template?type=design&mode=design&t=tMpD9KjtmPxIvPP1-1). + +## Prerequisites + +List any prerequisites or dependencies required to run the project. For example: + +- Node.js +- npm + +## Getting Started + +Ensure you have Node.js and npm (or Yarn) installed on your system. You can install Node.js from the official Node.js website. + +1. Fork the repository: In the upper right corner of the repository page, click on the "Fork" button. This will create a copy of the repository in your GitHub account. +2. Clone the repository: On your forked repository page, click on the "Code" button. This will reveal a URL. Click on the clipboard icon next to the URL to copy it. Then in your terminal, navigate to the directory where you want to clone the repository. Use the git clone command followed by the repository URL you copied earlier: `git clone ` +3. Install Dependencies: In your terminal, `run npm install` +4. You're done! Run `npm run dev` to view the site! + +## Contributions + +This project was created with contributions from: + +- **Design**: Laura Wu +- **Implementation**: Dora Weng + +## Usage and Attribution + +You are free to use the code and resources from this repository in your projects. However, if you find them helpful and decide to use them, please provide appropriate credit by mentioning the source of the code, such as linking back to this repository or acknowledging the original authorship. + +Thank you for your consideration!