Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Project metadata, refactoring, and adjustments to the README #2

Merged
merged 3 commits into from
Apr 14, 2024

Conversation

amotl
Copy link
Member

@amotl amotl commented Apr 14, 2024

About

This patch intends to bring in a first iteration on matters enumerated within GH-1. It does not change anything on the program's behaviour, it only adjusts its layout, improves documentation, and adds a project metadata file which will make it possible to install the program as a package using pip install.

Details

  • Chore: Add project metadata and boilerplate
  • Refactoring: Improve modularization and invocation semantics
  • Improve README: Layout and wording

@amotl amotl requested a review from bee-mois April 14, 2024 18:44
@amotl amotl marked this pull request as ready for review April 14, 2024 18:44
@amotl amotl changed the title Project metadata, refactoring, and README Project metadata, refactoring, and adjustments to the README Apr 14, 2024
@bee-mois
Copy link
Collaborator

thanks for your caring on that.

@bee-mois bee-mois merged commit d4db415 into main Apr 14, 2024
@bee-mois bee-mois deleted the refactoring-one branch April 14, 2024 20:30
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