Skip to content

README.md matches new infrastructure#6

Merged
turbomam merged 6 commits into
mainfrom
5-update-the-readmemd-or-any-other-documentation-to-reflect-the-new-use-cases-with-or-without-makefile-targets
Jul 9, 2025
Merged

README.md matches new infrastructure#6
turbomam merged 6 commits into
mainfrom
5-update-the-readmemd-or-any-other-documentation-to-reflect-the-new-use-cases-with-or-without-makefile-targets

Conversation

@turbomam

@turbomam turbomam commented Jul 9, 2025

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings July 9, 2025 17:21

This comment was marked as outdated.

turbomam and others added 4 commits July 9, 2025 13:23
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@turbomam turbomam requested a review from Copilot July 9, 2025 17:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR aligns project metadata and documentation with the new infrastructure by switching to a dedicated LICENSE file and vastly expanding the README.

  • Moved license declaration in pyproject.toml to reference the LICENSE file and included it in packaging
  • Added an MIT LICENSE file
  • Overhauled README.md with detailed installation, usage, development, and architecture sections

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
pyproject.toml Changed license to use file = "LICENSE" and added it to include
README.md Expanded and restructured documentation, updated installation and usage examples, changed license to MIT
LICENSE Added MIT license text
Comments suppressed due to low confidence (1)

README.md:245

  • [nitpick] You could link directly to the full license file for clarity, e.g., ## License This project is licensed under the [MIT License](LICENSE).
## License

Comment thread pyproject.toml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@turbomam turbomam merged commit 66a69a0 into main Jul 9, 2025
2 checks 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.

update the README.md or any other documentation to reflect the new use cases, with or without makefile targets

2 participants