Skip to content

Updated README with installation instructions + other changes#12

Merged
sidsun1 merged 3 commits into
mainfrom
docs
Aug 28, 2025
Merged

Updated README with installation instructions + other changes#12
sidsun1 merged 3 commits into
mainfrom
docs

Conversation

@sidsun1
Copy link
Copy Markdown
Contributor

@sidsun1 sidsun1 commented Aug 27, 2025

Summary

  • Added a short installation guide for both Docker and Virtual Environment setups
  • Updated contribution instructions with a list of concerns regarding Python linting/formatting following PEP8 using Ruff

Related Issues

@sidsun1 sidsun1 requested a review from MiguelR222 August 27, 2025 04:22
@sidsun1 sidsun1 mentioned this pull request Aug 27, 2025
Copy link
Copy Markdown
Contributor

@MiguelR222 MiguelR222 left a comment

Choose a reason for hiding this comment

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

All LGTM, in a future Issue it will be good to separate the README and a CONTRIBUTING.md file, for how contributions will be accepted, especially if we are to do checks for commits, branch names, and PR formatting.

Copy link
Copy Markdown
Contributor

@MiguelR222 MiguelR222 left a comment

Choose a reason for hiding this comment

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

All LG thanks!

@sidsun1 sidsun1 merged commit 55470c5 into main Aug 28, 2025
1 check passed
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