-
-
Notifications
You must be signed in to change notification settings - Fork 150
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 install
section of README.md
#344
Conversation
fix typo in 3 words and make pytest code word
@KrishPatel13 This wouldn't be a |
install
section of README.mdinstall
section of README.md
@abrichr Ready for review! |
A: Strongly agree! Addressed in: f4957b2
A: Yes, it would be helpful to provide an explanation for when someone should use the install script versus following the manual steps. Addressed in: 7a1c188 |
-- when someone should use the install script vs. follow the steps here?
@abrichr Ready for review! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Self-reviewed!
Ready for merging! @abrichr |
@abrichr addressed all the comments! |
* run `poetry lock --no-update` * fix: update CONTRIBUTING.md fix typo in 3 words and make pytest code word * fix: add required dependencies * add seup.md * add setup.md * remove typo * rename temporarily * rename to SETUP.md * update README to include more documentation on -- when someone should use the install script vs. follow the steps here? * remove requirements.txt * add link to installation * rename typo: prerequisite * link to start: https://openadapt.ai/#start * reomve .venv as requirements.txt is no longer used * update installation instructions * update the Windows Installtion command (in favour of): 1. https://github.com/OpenAdaptAI/OpenAdaptWeb/pull/30/files#r1252126510 2. https://github.com/OpenAdaptAI/OpenAdaptWeb/pull/30/files#r1252128457 * addressing comment: OpenAdaptAI#344 (comment) * address the comment: OpenAdaptAI#344 (comment) * address the comment: https://github.com/OpenAdaptAI/OpenAdapt/pull/344/files#r1252175602 * add .venv to address the comment: https://github.com/OpenAdaptAI/OpenAdapt/pull/344/files#r1252172932 and https://github.com/OpenAdaptAI/OpenAdapt/pull/289/files#r1252150636
What kind of change does this PR introduce?
Bugfix: Update install section in README.md
Summary
Checklist
How can your code be run and tested?
Follow https://github.com/OpenAdaptAI/OpenAdapt#install on a machine without tesseract.