add documentation and files to specify dependency versions

rramphal commented 8 months ago

Thank you for this very cool project!

The README currently only specifies the PyGAM dependency, and yet the project itself has several other dependencies.

The project also has some complex dependency versioning:

PyGAM uses np.int which was removed from NumPy 1.24, and so we must use NumPy 1.23.5
PyGAM 0.9.0 requires at least NumPy 1.24.2, so we must downversion to PyGAM 0.8.0
NumPy 1.23.5 and PyGAM 0.8.0 only support up through Python 3.11

This PR specify dependencies which satisfy these constraints via a requirements.txt file and a .python-version file. It also includes some hints towards installing an older version of Python. Finally, it reworks some of the text/headings for clarity.

abubelinha commented 7 months ago

@rramphal @tomstog is it possible to use this package for aligning full scanned pages? (i.e. with 30-40 lines of curvy text) The sample images in README only contain one or two lines, so I'd like to know before installing

TomStog commented 7 months ago

@abubelinha Thank you for your comment. Unfortunately, such an algorithm can't be used for full scanned pages at the current moment.

TomStog / curved-text-alignment

add documentation and files to specify dependency versions #2