Quickstart

Quickstart#

Follow these steps to get up and running:

  1. Clone the repository:

    git clone "git@github.com:TRU-CS/COMP_4910.git"

  2. Create and activate a Python virtual environment:

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

  3. Install dependencies:

    pip3 install -r requirements.txt

  4. Add your PDF files to the pdf_files/ directory.

  5. Run the agent to process and convert files (see Usage Guide).

  6. Build the Jupyter Book:

    jupyter-book build myTextbook/

  7. Preview the output in myTextbook/_build/html/.