diff --git a/.gitignore b/.gitignore index b27ba4b..72a2ccb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .DS_Store .vscode/ /03_instructional_team/node_modules +.venv \ No newline at end of file diff --git a/README.md b/README.md index 46eba89..ce13695 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Participants are encouraged to engage actively during the learning module. They * Participants are encouraged to ask questions, and collaborate with others to enhance their learning experience. * Participants must have a computer and an internet connection to participate in online activities. * Participants must not use generative AI such as ChatGPT to generate code in order to complete assignments. It should be used as a supportive tool to seek out answers to questions you may have. -* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/tree/main/onboarding_documents). +* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/blob/main/environment_setup/README.md). * We encourage participants to default to having their camera on at all times, and turning the camera off only as needed. This will greatly enhance the learning experience for all participants and provides real-time feedback for the instructional team. ## Resources @@ -131,6 +131,7 @@ Feel free to use the following as resources: ├── 04_this_cohort ├── .gitignore ├── LICENSE +├── SETUP.md └── README.md ``` @@ -141,5 +142,6 @@ Feel free to use the following as resources: * **this_cohort**: Additional materials and resources for this cohort. * **.gitignore**: Files to exclude from this folder, specified by the Technical Facilitator * **LICENSE**: The license for this repository. +* **SETUP.md**: Contains the steps required to set up this repo for the module. * **README**: This file. diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 0000000..a803e4b --- /dev/null +++ b/SETUP.md @@ -0,0 +1,11 @@ +## Setup + +Before using this repo, make sure you’ve completed the [environment setup guide](https://github.com/UofT-DSI/onboarding/blob/main/environment_setup/README.md), which installs the core tools you’ll need for this module, such as: + +- Git +- Git Bash (for Windows) +- Visual Studio Code + +This module does not require any additional packages. + +Once that’s done, simply open your terminal (macOS/Linux) or Git Bash (Windows), and you’re ready to begin this module. \ No newline at end of file