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

docs: update ReadMe with installation instructions #16

Open
DRMPN opened this issue Dec 19, 2024 · 0 comments
Open

docs: update ReadMe with installation instructions #16

DRMPN opened this issue Dec 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@DRMPN
Copy link
Contributor

DRMPN commented Dec 19, 2024

Problem
Currently, the readme suggests installing the framework via pip, even though it's not there.

Possible solution
I suggest adding the instructions on how to install the framework and it's additional tools with the use of requirements.txt file.
There is also a poetry.lock file, it's better to add a HowTo as well.

@DRMPN DRMPN added the documentation Improvements or additions to documentation label Dec 19, 2024
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

No branches or pull requests

1 participant