summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2022-01-25 18:51:17 +0100
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2022-01-25 18:51:17 +0100
commitfa2aec1a9d90758a952659796d8faf0fb0496ce2 (patch)
tree6eff719fe1c910925ea843b71c1ab93d24bcee47
parent4ff3c5d44b8f1e809c6c1d6b0fd8bad999961301 (diff)
chore: update README.md
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 96ad21b..8eae924 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,27 @@
# Text Recognizer
Implementing the text recognizer project from the course ["Full Stack Deep Learning Course"](https://fullstackdeeplearning.com/march2019) (FSDL) in PyTorch in order to learn best practices when building a deep learning project. I have expanded on this project by adding additional feature and ideas given by Claudio Jolowicz in ["Hypermodern Python"](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/).
+## Prerequisite
+
+### pyenv
+
+[pyenv](https://github.com/pyenv/pyenv) (or similar) and python 3.9.\* installed.
+
+### nox
+
+[nox](https://nox.thea.codes/en/stable/index.html) for linting, formatting, and testing.
+
+### Poetry
+
+[Poetry](https://python-poetry.org/) is a project manager for python.
+
## Installation
Install poetry and pyenv.
```sh
-pyenv local 3.9.1
+pyenv local 3.9.\*
+make check
make install
```