Skip to content

Commit 23f8f2f

Browse files
committed
Update installation instructions
1 parent ab7e8aa commit 23f8f2f

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,19 @@ Installation
4747
------------
4848
Installation with pip
4949
.....................
50-
Python-isal can be installed with::
5150

52-
pip install isal
53-
54-
This will include a staticallly linked version of isa-l. On Linux, wheels
55-
are provided. If a wheel is not provided for your system the installation will
56-
build ISA-L first in a temporary directory. Please check the `ISA-L homepage
57-
<https://github.com/intel/isa-l>`_ for the build requirements.
51+
+ Linux: ``pip install isal``. Wheels are provided, so installation should
52+
be almost instantaneous.
53+
+ MacOS: make sure ``gcc``, ``yasm``, ``automake`` and ``autoconf`` packages
54+
are installed. These can be installed via `Homebrew <https://brew.sh/>`_ with
55+
``brew install gcc yasm automake autoconf``. Then proceed with ``pip
56+
install isal``. The package will be build on your computer.
57+
+ Windows: Installation is not supported yet.
58+
59+
The installation will include a staticallly linked version of isa-l. On Linux,
60+
wheels are provided. If a wheel is not provided for your system the
61+
installation will build ISA-L first in a temporary directory. Please check the
62+
`ISA-L homepage <https://github.com/intel/isa-l>`_ for the build requirements.
5863

5964
The latest development version of python-isal can be installed with::
6065

setup.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ def build_isa_l():
145145
"Development Status :: 3 - Alpha",
146146
"Topic :: System :: Archiving :: Compression",
147147
"License :: OSI Approved :: MIT License",
148+
"Operating System :: POSIX :: Linux",
149+
"Operating System :: MacOS"
148150
],
149151
python_requires=">=3.6",
150152
ext_modules=[

0 commit comments

Comments
 (0)