Skip to content

Add requirements.txt with initial package dependencies#13

Open
GalexY727 wants to merge 3 commits intomainfrom
requirements.txt
Open

Add requirements.txt with initial package dependencies#13
GalexY727 wants to merge 3 commits intomainfrom
requirements.txt

Conversation

@GalexY727
Copy link
Copy Markdown
Member

will simplify the onboarding setup and make it so that you can easily see requirements in one places rather than having to look through the README

Copilot AI review requested due to automatic review settings March 17, 2026 23:19
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a pinned Python dependency list to make local setup reproducible and updates contributor docs to install dependencies from that file instead of ad-hoc pip install commands.

Changes:

  • Added requirements.txt with pinned MkDocs + theme/plugin dependencies.
  • Updated README.md setup steps to pip3 install -r requirements.txt.
  • Added an explicit cd step after cloning in the README.

Reviewed changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.

File Description
requirements.txt Introduces a pinned dependency set intended to standardize local installs.
README.md Updates onboarding instructions to use the new requirements.txt and clarifies setup steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md
Comment on lines 28 to 30
```bash
pip3 install mkdocs-material mkdocs-glightbox
pip3 install -r requirements.txt
```
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants