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 install section of README.md #344

Merged
merged 23 commits into from
Jul 6, 2023

Conversation

KrishPatel13
Copy link
Collaborator

@KrishPatel13 KrishPatel13 commented Jul 3, 2023

What kind of change does this PR introduce?
Bugfix: Update install section in README.md

Summary

  • Add TesseractOCR Setup

Checklist

  • My code follows the style guidelines of OpenAdapt
  • I have performed a self-review of my code
  • If applicable, I have added tests to prove my fix is functional/effective
  • I have linted my code locally prior to submission
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (e.g. README.md, requirements.txt)
  • New and existing unit tests pass locally with my changes

How can your code be run and tested?
Follow https://github.com/OpenAdaptAI/OpenAdapt#install on a machine without tesseract.

@KrishPatel13 KrishPatel13 self-assigned this Jul 3, 2023
Krish Patel added 2 commits July 3, 2023 14:41
fix typo in 3 words and make pytest code word
@Mustaballer
Copy link
Collaborator

@KrishPatel13 This wouldn't be a fix, but should be replaced with docs, since this PR is Documentation-only changes. Refer to CONTRIBUTING.md for more detail

@KrishPatel13 KrishPatel13 changed the title fix: update install section of README.md docs: update install section of README.md Jul 3, 2023
README.md Outdated Show resolved Hide resolved
@KrishPatel13 KrishPatel13 requested a review from abrichr July 4, 2023 01:05
@KrishPatel13
Copy link
Collaborator Author

@abrichr Ready for review!

@KrishPatel13
Copy link
Collaborator Author

KrishPatel13 commented Jul 4, 2023

#324 (comment)

should we name it SETUP.md to match the other .md files?

A: Strongly agree! Addressed in: f4957b2

should we add an explanation for when someone should use the install script vs. follow the steps here?

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

@KrishPatel13 KrishPatel13 mentioned this pull request Jul 4, 2023
7 tasks
CONTRIBUTING.md Outdated Show resolved Hide resolved
-- when someone should use the install script vs. follow the steps here?
@KrishPatel13 KrishPatel13 requested a review from Mustaballer July 4, 2023 02:38
@KrishPatel13
Copy link
Collaborator Author

@abrichr Ready for review!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
.gitignore Show resolved Hide resolved
.gitignore Show resolved Hide resolved
Copy link
Collaborator Author

@KrishPatel13 KrishPatel13 left a comment

Choose a reason for hiding this comment

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

Self-reviewed!

@KrishPatel13
Copy link
Collaborator Author

Ready for merging! @abrichr

@KrishPatel13 KrishPatel13 requested a review from abrichr July 4, 2023 15:17
README.md Outdated Show resolved Hide resolved
SETUP.md Outdated Show resolved Hide resolved
SETUP.md Outdated Show resolved Hide resolved
@KrishPatel13
Copy link
Collaborator Author

@abrichr addressed all the comments!

@KrishPatel13 KrishPatel13 linked an issue Jul 4, 2023 that may be closed by this pull request
@KrishPatel13 KrishPatel13 requested a review from abrichr July 5, 2023 17:13
@abrichr abrichr merged commit 755dd55 into OpenAdaptAI:main Jul 6, 2023
R-ohit-B-isht pushed a commit to R-ohit-B-isht/OpenAdapt that referenced this pull request Jun 21, 2024
* 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
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.

[Bug]: README.md installation does not include tesseract and other dependencies Remove requirements.txt
3 participants