diff --git a/README.md b/README.md index 1ec436f..d3434e1 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,20 @@ Symmetrization of 2D pattern using nonrigid landmark registration with symmetry ### Installation -Install the PyPI version +1. Install the PyPI version -```bash -pip install symmetrize -``` +
pip install symmetrize
-Install the latest version from source repository
+2. Install the latest version from source repository
-```bash
-pip install git+https://github.com/RealPolitiX/symmetrize.git
-```
+ pip install git+https://github.com/RealPolitiX/symmetrize.git
### Requirements
See [requirements](https://github.com/RealPolitiX/symmetrize/blob/master/requirements.txt)
+
### Documentation and use
Documentation of the package may be found [here](https://realpolitix.github.io/symmetrize/html/index.html) along with examples illustrating the main functionalities in [here](https://github.com/RealPolitiX/symmetrize/tree/master/examples).
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
index 9bb9273..1e19684 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -10,4 +10,5 @@ opencv-python
# Packaging
sphinx_rtd_theme
sphinx
-recommonmark
\ No newline at end of file
+recommonmark
+pillow>=8.1.0 # not directly required, pinned by Snyk to avoid a vulnerability
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 8069ea4..3bad654 100644
--- a/setup.py
+++ b/setup.py
@@ -11,7 +11,7 @@
install_requires = [x.strip() for x in all_reqs if 'git+' not in x]
dependency_links = [x.strip().replace('git+', '') for x in all_reqs if x.startswith('git+')]
-with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+with open(path.join(here, 'README.md')) as f:
long_description = f.read()
setup(