Update installation instructions

This commit is contained in:
Nguyễn Gia Phong 2020-03-24 11:12:19 +07:00
parent 2405c4e448
commit 9265cec923
6 changed files with 36 additions and 31 deletions

Binary file not shown.

Binary file not shown.

View File

@ -4,8 +4,7 @@ Installation
Prerequisites
-------------
Palace requires Python 3.6 for runtime
and pip for installation.
Palace requires Python 3.6 for runtime and pip for installation.
Via PyPI
--------
@ -16,18 +15,21 @@ Palace can be installed from PyPI:
pip install palace
Wheel distributions are only built for GNU/Linux
and macOS on amd64 at the time of writing.
Wheel distributions are only built for GNU/Linux and macOS on amd64
at the time of writing.
However, the wheels for macOS does *not* include shared libraries like alure,
which are expected to be installed either from source or from Homebrew.
This is because we cannot (yet) get ``delocate`` to worked with alure
compiled from source, which showed up to be inside of ``@rpath``.
From source
-----------
Aside from the build dependencies listed in
:code:`pyproject.toml`, one will additionally need
compatible Python headers, alure, a C++11
compiler, CMake 2.6+ (and git for fetching the
source). Palace can then be compiled and installed
by running:
Aside from the build dependencies listed in ``pyproject.toml``,
one will additionally need compatible Python headers, alure, a C++14 compiler,
CMake 2.6+ (and git for fetching the source). Palace can then be compiled
and installed by running:
.. code-block:: sh

View File

@ -36,8 +36,7 @@
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>Palace requires Python 3.6 for runtime
and pip for installation.</p>
<p>Palace requires Python 3.6 for runtime and pip for installation.</p>
</div>
<div class="section" id="via-pypi">
<h2>Via PyPI<a class="headerlink" href="#via-pypi" title="Permalink to this headline"></a></h2>
@ -45,17 +44,19 @@ and pip for installation.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install palace
</pre></div>
</div>
<p>Wheel distributions are only built for GNU/Linux
and macOS on amd64 at the time of writing.</p>
<p>Wheel distributions are only built for GNU/Linux and macOS on amd64
at the time of writing.</p>
<p>However, the wheels for macOS does <em>not</em> include shared libraries like alure,
which are expected to be installed either from source or from Homebrew.
This is because we cannot (yet) get <code class="docutils literal notranslate"><span class="pre">delocate</span></code> to worked with alure
compiled from source, which showed up to be inside of <code class="docutils literal notranslate"><span class="pre">&#64;rpath</span></code>.</p>
</div>
<div class="section" id="from-source">
<h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline"></a></h2>
<p>Aside from the build dependencies listed in
<code class="code docutils literal notranslate"><span class="pre">pyproject.toml</span></code>, one will additionally need
compatible Python headers, alure, a C++11
compiler, CMake 2.6+ (and git for fetching the
source). Palace can then be compiled and installed
by running:</p>
<p>Aside from the build dependencies listed in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>,
one will additionally need compatible Python headers, alure, a C++14 compiler,
CMake 2.6+ (and git for fetching the source). Palace can then be compiled
and installed by running:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/McSinyx/palace.git
pip install palace/
</pre></div>

File diff suppressed because one or more lines are too long

View File

@ -4,8 +4,7 @@ Installation
Prerequisites
-------------
Palace requires Python 3.6 for runtime
and pip for installation.
Palace requires Python 3.6 for runtime and pip for installation.
Via PyPI
--------
@ -16,18 +15,21 @@ Palace can be installed from PyPI:
pip install palace
Wheel distributions are only built for GNU/Linux
and macOS on amd64 at the time of writing.
Wheel distributions are only built for GNU/Linux and macOS on amd64
at the time of writing.
However, the wheels for macOS does *not* include shared libraries like alure,
which are expected to be installed either from source or from Homebrew.
This is because we cannot (yet) get ``delocate`` to worked with alure
compiled from source, which showed up to be inside of ``@rpath``.
From source
-----------
Aside from the build dependencies listed in
:code:`pyproject.toml`, one will additionally need
compatible Python headers, alure, a C++11
compiler, CMake 2.6+ (and git for fetching the
source). Palace can then be compiled and installed
by running:
Aside from the build dependencies listed in ``pyproject.toml``,
one will additionally need compatible Python headers, alure, a C++14 compiler,
CMake 2.6+ (and git for fetching the source). Palace can then be compiled
and installed by running:
.. code-block:: sh