From 0885799010096a743510a8d3ea85f09a4eda4dee Mon Sep 17 00:00:00 2001 From: "James R. Barlow" Date: Sun, 28 Feb 2021 19:31:21 -0800 Subject: [PATCH] Update docs for conda Closes #743 --- README.md | 26 ++++++++--------------- docs/installation.rst | 48 ++++++++++++++++++++++++------------------- 2 files changed, 36 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index c4c16856..0c3b20cc 100644 --- a/README.md +++ b/README.md @@ -59,23 +59,15 @@ I searched the web for a free command line tool to OCR PDF files: I found many, Linux, Windows, macOS and FreeBSD are supported. Docker images are also available. -Users of Debian 9 or later or Ubuntu 16.10 or later may simply - -```bash -apt-get install ocrmypdf -``` - -and users of Fedora 29 or later may simply - -```bash -dnf install ocrmypdf -``` - -and Homebrew users (macOS, Linux, Windows Subsystem for Linux) may simply - -```bash -brew install ocrmypdf -``` +| Operating system | Install command | +| ----------------------------- | ------------------------------| +| Debian, Ubuntu | ``apt install ocrmypdf`` | +| Windows Subsystem for Linux | ``apt install ocrmypdf`` | +| Fedora | ``dnf install ocrmypdf`` | +| macOS | ``brew install ocrmypdf`` | +| LinuxBrew | ``brew install ocrmypdf`` | +| FreeBSD | ``pkg install py37-ocrmypdf`` | +| Conda | ``conda install ocrmypdf`` | For everyone else, [see our documentation](https://ocrmypdf.readthedocs.io/en/latest/installation.html) for installation steps. diff --git a/docs/installation.rst b/docs/installation.rst index f0524f07..9dc46286 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -12,19 +12,21 @@ system/platform. This version may be out of date, however. These platforms have one-liner installs: -+-----------------------------+-------------------------------+ -| Debian, Ubuntu | ``apt install ocrmypdf`` | -+-----------------------------+-------------------------------+ -| Windows Subsystem for Linux | ``apt install ocrmypdf`` | -+-----------------------------+-------------------------------+ -| Fedora | ``dnf install ocrmypdf`` | -+-----------------------------+-------------------------------+ -| macOS | ``brew install ocrmypdf`` | -+-----------------------------+-------------------------------+ -| LinuxBrew | ``brew install ocrmypdf`` | -+-----------------------------+-------------------------------+ -| FreeBSD | ``pkg install py37-ocrmypdf`` | -+-----------------------------+-------------------------------+ ++-------------------------------+-------------------------------+ +| Debian, Ubuntu | ``apt install ocrmypdf`` | ++-------------------------------+-------------------------------+ +| Windows Subsystem for Linux | ``apt install ocrmypdf`` | ++-------------------------------+-------------------------------+ +| Fedora | ``dnf install ocrmypdf`` | ++-------------------------------+-------------------------------+ +| macOS | ``brew install ocrmypdf`` | ++-------------------------------+-------------------------------+ +| LinuxBrew | ``brew install ocrmypdf`` | ++-------------------------------+-------------------------------+ +| FreeBSD | ``pkg install py37-ocrmypdf`` | ++-------------------------------+-------------------------------+ +| Conda (WSL, macOS, Linux) | ``conda install ocrmypdf`` | ++-------------------------------+-------------------------------+ More detailed procedures are outlined below. If you want to do a manual install, or install a more recent version than your platform provides, read on. @@ -54,6 +56,9 @@ Debian and Ubuntu 18.04 or newer .. |ubu-2004| image:: https://repology.org/badge/version-for-repo/ubuntu_20_04/ocrmypdf.svg :alt: Ubuntu 20.04 LTS +.. |ubu-2010| image:: https://repology.org/badge/version-for-repo/ubuntu_20_10/ocrmypdf.svg + :alt: Ubuntu 20.10 + +-----------------------------------------------+ | **OCRmyPDF versions in Debian & Ubuntu** | +-----------------------------------------------+ @@ -61,7 +66,7 @@ Debian and Ubuntu 18.04 or newer +-----------------------------------------------+ | |deb-stable| |deb-testing| |deb-unstable| | +-----------------------------------------------+ -| |ubu-1804| |ubu-2004| | +| |ubu-1804| |ubu-2004| |ubu-2010| | +-----------------------------------------------+ Users of Debian 9 ("stretch") or later, or Ubuntu 18.04 or later, including users @@ -90,15 +95,15 @@ For full details on version availability for your platform, check the automatically detect it (specifically the ``jbig2`` binary) on the ``PATH``. To add JBIG2 encoding, see :ref:`jbig2`. -Fedora 29 or newer ------------------- - -.. |fedora-31| image:: https://repology.org/badge/version-for-repo/fedora_31/ocrmypdf.svg - :alt: Fedora 31 +Fedora +------ .. |fedora-32| image:: https://repology.org/badge/version-for-repo/fedora_32/ocrmypdf.svg :alt: Fedora 32 +.. |fedora-33| image:: https://repology.org/badge/version-for-repo/fedora_33/ocrmypdf.svg + :alt: Fedora 33 + .. |fedora-rawhide| image:: https://repology.org/badge/version-for-repo/fedora_rawhide/ocrmypdf.svg :alt: Fedore Rawhide @@ -107,7 +112,7 @@ Fedora 29 or newer +-----------------------------------------------+ | |latest| | +-----------------------------------------------+ -| |fedora-31| |fedora-32| |fedora-rawhide| | +| |fedora-32| |fedora-33| |fedora-rawhide| | +-----------------------------------------------+ Users of Fedora 29 or later may simply @@ -355,7 +360,8 @@ To install OCRmyPDF for Alpine Linux: Mageia 7 -------- -Install the following dependencies: +There is no OS-level packaging available for Mageia, so you must install the +dependencies: .. code-block:: bash