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
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ from openadapt import models
In order to effectively communicate any bugs or request new features, please select the appropriate form. If none of the options suit your needs, you can click on "Open a blank issue" located at the bottom.

## Testing
[GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) are automatically run on each pull request to ensure consistent behaviour and style. The Actions are composed of PyTest, [black](https://github.com/psf/black) and [flake8](https://flake8.pycqa.org/en/latest/user/index.html).
[GitHub Actions](https://github.com/MLDSAI/OpenAdapt/actions/new) are automatically run on each pull request to ensure consistent behavior and style. The Actions are composed of PyTest, [black](https://github.com/psf/black) and [flake8](https://flake8.pycqa.org/en/latest/user/index.html).
KrishPatel13 marked this conversation as resolved.
Show resolved Hide resolved

You can run these tests on your own computer by downloading the depencencies in requirements.txt and then running pytest in the root directory.
You can run these tests on your own computer by downloading the dependencies in requirements.txt and then running `pytest` in the root directory.
KrishPatel13 marked this conversation as resolved.
Show resolved Hide resolved

## Pull Request Format

To speed up the review process, please use the provided pull request template and create a draft pull request to get initial feedback.

The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documenttation.
The pull request template includes areas to explain the changes, and a checklist with boxes for code style, testing, and documentation.

## Commit Message Format

Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ The direction is adjacent to [Adept.ai](https://adept.ai/), with some key differ

## Install

Required dependencies:
- Python 3.10
- Git
- Tesseract (for OCR)

Follow the setup instructions [here](./SETUP.md).


Install with [Poetry](https://python-poetry.org/) (recommended):
```
Expand Down
57 changes: 57 additions & 0 deletions SETUP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Setup Instructions for the following:

1. Python 3.10
2. Git
3. Tesseract (for OCR)



## Python 3.10

#### Windows:
- Download the Python 3.10 Binary File: https://www.python.org/ftp/python/3.10.0/python-3.10.0-amd64.exe
- Follow the steps for Installation here: https://www.digitalocean.com/community/tutorials/install-python-windows-10


#### macOS:
- Download the Python 3.10 Package Installer: https://www.python.org/ftp/python/3.10.11/python-3.10.11-macos11.pkg
- Follow the steps for Installation here: https://www.codingforentrepreneurs.com/guides/install-python-on-macos/


#### Ubuntu
- Open Terminal and type the following command:
- `sudo apt install python3.10-full`




## Git

#### Windows:
- Download system appropriate binary (exe) file from here: https://git-scm.com/download/win
- Install the setup file.


#### macOS:
- Follow the steps here: https://git-scm.com/download/mac


#### Ubuntu (Linux and Unix):
- Follow the steps here: https://git-scm.com/download/linux




## Tesseract OCR

#### Windows:
- Download the following binary (.exe) file:
[Tesseract Setup](https://digi.bib.uni-mannheim.de/tesseract/tesseract-ocr-w64-setup-5.3.1.20230401.exe)
- Run the setup file and Install the Tesseract OCR
KrishPatel13 marked this conversation as resolved.
Show resolved Hide resolved
- Add Tesseract to User and System PATH variable.
Follow the following article for the above step.
KrishPatel13 marked this conversation as resolved.
Show resolved Hide resolved
- See Step 5 and 6 in https://linuxhint.com/install-tesseract-windows/


#### macOS, Ubuntu and Other Operating System:
- Follow the OS Specific installation here: https://tesseract-ocr.github.io/tessdoc/Installation.html