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

README: Explicit the main requirements #14

Merged
merged 1 commit into from
May 24, 2024
Merged

README: Explicit the main requirements #14

merged 1 commit into from
May 24, 2024

Conversation

ErwanAliasr1
Copy link
Collaborator

When people discover the project, it's cool to give a quick overview of what are the dependencies to make this project being used.

This was referenced May 23, 2024
This was referenced May 23, 2024
@ErwanAliasr1 ErwanAliasr1 added the documentation Improvements or additions to documentation label May 23, 2024
@ErwanAliasr1 ErwanAliasr1 self-assigned this May 23, 2024

# Requirements
## Mandatory
- python >= 3.9
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't we want to document the runtime python dependencies? Or maybe link to requirements/base.in ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I asked myself the same question.
Maybe linking is better

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's add the link in another commit/PR.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Why in another PR ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Just in case. Works with this PR.


# Requirements
## Mandatory
- python >= 3.9
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's add the link in another commit/PR.

When people discover the project, it's cool to give a quick overview of
what are the dependencies to make this project being used.

Signed-off-by: Erwan Velu <[email protected]>
Copy link
Collaborator

@beorn- beorn- left a comment

Choose a reason for hiding this comment

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

LGTM


# Requirements
## Mandatory
- python >= 3.9
Copy link
Contributor

Choose a reason for hiding this comment

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

Just in case. Works with this PR.

@ErwanAliasr1 ErwanAliasr1 merged commit bcb2a5b into main May 24, 2024
4 checks passed
@ErwanAliasr1 ErwanAliasr1 deleted the require branch June 5, 2024 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants