Overview

Welcome! This guide is your starting point for building a custom digital textbook using this project. Whether you’re an instructor, student, or self-learner, you’ll find step-by-step instructions to help you set up your environment and get ready to create your own interactive learning resource. No advanced technical skills required—just follow along and you’ll be up and running in no time!

1. Fork the Project

• Go to the GitHub repository for this project.

• Click the Fork button in the top right to create your own copy of the repository.

• Clone your forked repository to your local machine:

  git clone https://github.com/TRU-CS/COMP_4910.git
  cd COMP_4910
  

2. Initialize and Install Required Libraries

Think of the virtual environment as a sandbox for your project. It keeps your dependencies organized and avoids conflicts with other Python projects on your computer.

Warning

Make sure you have Python 3.8 or higher installed. Using an older version may cause errors when installing dependencies or running the code.

• (Recommended) Create a virtual environment:

  python3 -m venv .venv
  source .venv/bin/activate
  

  Tip

  For more details, see Python: venv documentation or this VS Code Python environment guide.

• Install the required dependencies:

  pip install -r requirements.txt
  

You’ve now set up your project environment and are ready to start building your own textbook. Remember, if you ever get stuck, don’t hesitate to check the tips above or reach out for help.