feat: Add APT installation instructions to documentation
- Updated installation documentation to include instructions for installing mediacurator via APT repository. - Added a table of contents for easier navigation. - Moved FFmpeg installation instructions to the bottom, noting that they are only required when installing via pip if not already installed.
This commit is contained in:
parent
cc6fe4943c
commit
a82e97de75
@ -2,8 +2,61 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
.. _install_toc:
|
||||
|
||||
Table of contents
|
||||
-----------------
|
||||
|
||||
* :ref:`install_about`
|
||||
* :ref:`install_apt`
|
||||
* :ref:`install_pypi`
|
||||
* :ref:`install_ffmpeg`
|
||||
|
||||
.. _install_about:
|
||||
|
||||
About mediacurator's installation
|
||||
---------------------------------
|
||||
|
||||
This package has been tested on GNU/Linux (e.g., Debian, Ubuntu, Fedora) and Windows, and requires FFmpeg to be installed. For now, it will be distributed on `GitHub <https://github.com/fabquenneville/mediacurator.git>`_.
|
||||
|
||||
.. _install_apt:
|
||||
|
||||
Install from APT Repository
|
||||
----------------------------
|
||||
|
||||
The `mediacurator` package is now available through an APT repository. To install it along with all its dependencies (including Python, required Python packages, and FFmpeg) on a Debian/Ubuntu compatible system, follow these steps:
|
||||
|
||||
1. Add the APT repository to your system by following the instructions at the `repository homepage <https://debrepo.fabq.ca/>`_.
|
||||
|
||||
2. Update your package list:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt update
|
||||
|
||||
3. Install `mediacurator`:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt install -y mediacurator
|
||||
|
||||
This will automatically install the `mediacurator` package and all its dependencies.
|
||||
|
||||
.. _install_pypi:
|
||||
|
||||
Install from PyPi
|
||||
-----------------
|
||||
|
||||
You can install the `mediacurator` package directly from PyPi using the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install mediacurator
|
||||
|
||||
**Note:** If FFmpeg is not already installed, please refer to the instructions in the :ref:`install_ffmpeg` section.
|
||||
|
||||
.. _install_ffmpeg:
|
||||
|
||||
Install FFmpeg
|
||||
--------------
|
||||
|
||||
@ -29,13 +82,3 @@ To verify your FFmpeg installation, you can run:
|
||||
.. code-block:: bash
|
||||
|
||||
ffmpeg -version
|
||||
|
||||
|
||||
Install from PyPi
|
||||
-----------------
|
||||
|
||||
You can install the `mediacurator` package directly from PyPi using the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install mediacurator
|
||||
|
||||
@ -60,8 +60,11 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-ffmpeg">Install FFmpeg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#table-of-contents">Table of contents</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#about-mediacurator-s-installation">About mediacurator’s installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-apt-repository">Install from APT Repository</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-pypi">Install from PyPi</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-ffmpeg">Install FFmpeg</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
|
||||
|
||||
@ -2,5 +2,7 @@
|
||||
# Project: mediacurator
|
||||
# Version: 0.0.13
|
||||
# The remainder of this file is compressed using zlib.
|
||||
xΪ•–MΣ“0Ηο|<7C>8zΠ} ουθΛΑu<><75>γ±Γ–2†¤&AνΝ―αΧσ“,<OΒ¦—°»<C2B0>_v»μΒ¤ψΚm²η<C2B2>~Nβ”T<E2809D>ζpWi80<38>AΟN¦δ<C2A6><CEB4><EFBFBD>Τ°Qƒ`2ƒθx¥¤Ί)φL EΪψBδ¤<CEB4>ΧQΆό+υO[ ς¦Ή<C2A6>®n™d<E284A2>Σΐγ p&K F’²‚²JQ#Υίί4©½«„΅¦<CE85>βQΔ!§μr`®δ;›3k‹ϋΈϋιBk<42> k^OΩK΄>oΫkςjx8ςt―€¤³δY/η,sΐ)ϋΈΙ<CE88>w:ΌΠζΐΚμfH7<>{US'z”<7A>lι¥Ο•Καf]µo~£‘»=χ° fΫ―G)Z{!΄΅<CE84>ΫRϋD†N}χ]<5D><>K**Κ½RΦlEήµΧγποUΑΎΥΪ]Ί$®.VζΓ<CEB6>ϋΘ]H―<48>ΈΤδ³<06>ή<EFBFBD>u~RUΏxΉ_¦wθ^»ξ.rχ<72>ϋOφwMΩ΄ηƒYpΎΔ½΅«¥Μ*έTp΄<70>g Ω†¨!<21>ύΕ<CF8D>κFΡp¨5…4 ο’Y2KcvΆ".σaΝ¦όΊ$<24>1υ<31><CF85>)<29>z<EFBFBD><7A>6<EFBFBD>ΌoΆ ¨$”•ΰ°¥g<16><1A>Ϋ<”6Ηis”¶¥-pΪ£-aK”µΔP«@Τ
|
||||
E0Τ:µFQk µ DmPΤCmQ[µΕP»@ΤEν¦Piΰ<69>J]Cjψ-ERΗ<52><CE97>@Uύ<55>1¤φ™ψdνϋz GΎ ξ]ήΣ[;h]ϋφ΄wAOmft%Oμbd ϋ·οδΪύΚ<*½
|
||||
xÚ•–Í’”0Çï<E,=è<>Y˜Ùùò¶~lÕV©…º–Ç©LhJ ˜•›¯áëù$3à.<14>þÿ4tº!4ÿL .—)>BŠ\ • ÇpSr8Ì<>/N"KŸ>C¯° 'ÄÀ…œÐœ(Æ(›¥-pÂP£Oò5zîÄ<C3AE>'y¿†NÝÝÆ=Ô§Î%,¤¤êE|…”Ð <0C> (ƒ0Á¤dXPö÷÷ Ždt™A.°HhþDÚp<C39A>Óô€<C3B4>´ÔæÞ4á*…öŽ«$wÍñ
|
||||
Ó—] Å\„<¨s1š¡»à}‚‚òD‚ª³qeÄó¼[Mg__ž ‹ªHæù5ŠÁÃU<>œ
…üJ³üjÁ#>¦€h„Í…ühÜI!Ƥ:]±¶kÚºSkn§û¿€[©,>ô¼TUgÑļkÎÑ›~1¡çä/¼<17><>v[X<e§›Ü*Ošpq Y8R ÝZ°$2ш²LÕk«.JÃl_¥
|
||||
ê£3WÏÝß²šeµ<65>ßR¼®”Q“«rê*r<>˜ŠÍp^âtÔJ-+“÷ÍùPþ½LÈ7éÝV¡Îâ¢l>ž¯ ý‹ u¾jô…j.‡>?1“<31>2 ·éÚ6Ù^9úÒäñªÉêò¼êÝEåv í»¤a)7µê⚪ znLP‰“,”<01>A
|
||||
Ò3§ø<>·ð¾KN8<4E>!¥qÿ<71>MŵIÔýþµê÷¨‰<C2A8>m¹¡µJƒòlYžæiÖ™Y¤fÎmiK[šiK#meK[™i+íÖvkdÝšPkKÔÚˆZ›PKÔƈژP[KÔÖˆÚšP;KÔΈڙP{KÔÞˆÚO¡|Ë&åëšTÿ§ùš&Å3ùƒ1h¤êž2ø¬ÖÙ<><C399>±>:¼§§¶Õ¸ ›Ó£zj2GòÄ,6 áñé;9vÿƒòÌu
|
||||
File diff suppressed because one or more lines are too long
@ -36,9 +36,47 @@
|
||||
|
||||
<section id="installation">
|
||||
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
|
||||
<section id="table-of-contents">
|
||||
<span id="install-toc"></span><h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#install-about"><span class="std std-ref">About mediacurator’s installation</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#install-apt"><span class="std std-ref">Install from APT Repository</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#install-pypi"><span class="std std-ref">Install from PyPi</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="#install-ffmpeg"><span class="std std-ref">Install FFmpeg</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="about-mediacurator-s-installation">
|
||||
<span id="install-about"></span><h2>About mediacurator’s installation<a class="headerlink" href="#about-mediacurator-s-installation" title="Link to this heading">¶</a></h2>
|
||||
<p>This package has been tested on GNU/Linux (e.g., Debian, Ubuntu, Fedora) and Windows, and requires FFmpeg to be installed. For now, it will be distributed on <a class="reference external" href="https://github.com/fabquenneville/mediacurator.git">GitHub</a>.</p>
|
||||
</section>
|
||||
<section id="install-from-apt-repository">
|
||||
<span id="install-apt"></span><h2>Install from APT Repository<a class="headerlink" href="#install-from-apt-repository" title="Link to this heading">¶</a></h2>
|
||||
<p>The <cite>mediacurator</cite> package is now available through an APT repository. To install it along with all its dependencies (including Python, required Python packages, and FFmpeg) on a Debian/Ubuntu compatible system, follow these steps:</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Add the APT repository to your system by following the instructions at the <a class="reference external" href="https://debrepo.fabq.ca/">repository homepage</a>.</p></li>
|
||||
<li><p>Update your package list:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Install <cite>mediacurator</cite>:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>mediacurator
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
<p>This will automatically install the <cite>mediacurator</cite> package and all its dependencies.</p>
|
||||
</section>
|
||||
<section id="install-from-pypi">
|
||||
<span id="install-pypi"></span><h2>Install from PyPi<a class="headerlink" href="#install-from-pypi" title="Link to this heading">¶</a></h2>
|
||||
<p>You can install the <cite>mediacurator</cite> package directly from PyPi using the following command:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>mediacurator
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Note:</strong> If FFmpeg is not already installed, please refer to the instructions in the <a class="reference internal" href="#install-ffmpeg"><span class="std std-ref">Install FFmpeg</span></a> section.</p>
|
||||
</section>
|
||||
<section id="install-ffmpeg">
|
||||
<h2>Install FFmpeg<a class="headerlink" href="#install-ffmpeg" title="Link to this heading">¶</a></h2>
|
||||
<span id="id1"></span><h2>Install FFmpeg<a class="headerlink" href="#install-ffmpeg" title="Link to this heading">¶</a></h2>
|
||||
<p>To install FFmpeg, you can follow the instructions for your platform:</p>
|
||||
<ul>
|
||||
<li><dl>
|
||||
@ -65,13 +103,6 @@ sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> <
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="install-from-pypi">
|
||||
<h2>Install from PyPi<a class="headerlink" href="#install-from-pypi" title="Link to this heading">¶</a></h2>
|
||||
<p>You can install the <cite>mediacurator</cite> package directly from PyPi using the following command:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>mediacurator
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
@ -98,8 +129,11 @@ sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> <
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-ffmpeg">Install FFmpeg</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#table-of-contents">Table of contents</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#about-mediacurator-s-installation">About mediacurator’s installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-from-apt-repository">Install from APT Repository</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-from-pypi">Install from PyPi</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-ffmpeg">Install FFmpeg</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
|
||||
|
||||
@ -2,8 +2,61 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
.. _install_toc:
|
||||
|
||||
Table of contents
|
||||
-----------------
|
||||
|
||||
* :ref:`install_about`
|
||||
* :ref:`install_apt`
|
||||
* :ref:`install_pypi`
|
||||
* :ref:`install_ffmpeg`
|
||||
|
||||
.. _install_about:
|
||||
|
||||
About mediacurator's installation
|
||||
---------------------------------
|
||||
|
||||
This package has been tested on GNU/Linux (e.g., Debian, Ubuntu, Fedora) and Windows, and requires FFmpeg to be installed. For now, it will be distributed on `GitHub <https://github.com/fabquenneville/mediacurator.git>`_.
|
||||
|
||||
.. _install_apt:
|
||||
|
||||
Install from APT Repository
|
||||
----------------------------
|
||||
|
||||
The `mediacurator` package is now available through an APT repository. To install it along with all its dependencies (including Python, required Python packages, and FFmpeg) on a Debian/Ubuntu compatible system, follow these steps:
|
||||
|
||||
1. Add the APT repository to your system by following the instructions at the `repository homepage <https://debrepo.fabq.ca/>`_.
|
||||
|
||||
2. Update your package list:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt update
|
||||
|
||||
3. Install `mediacurator`:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt install -y mediacurator
|
||||
|
||||
This will automatically install the `mediacurator` package and all its dependencies.
|
||||
|
||||
.. _install_pypi:
|
||||
|
||||
Install from PyPi
|
||||
-----------------
|
||||
|
||||
You can install the `mediacurator` package directly from PyPi using the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install mediacurator
|
||||
|
||||
**Note:** If FFmpeg is not already installed, please refer to the instructions in the :ref:`install_ffmpeg` section.
|
||||
|
||||
.. _install_ffmpeg:
|
||||
|
||||
Install FFmpeg
|
||||
--------------
|
||||
|
||||
@ -29,13 +82,3 @@ To verify your FFmpeg installation, you can run:
|
||||
.. code-block:: bash
|
||||
|
||||
ffmpeg -version
|
||||
|
||||
|
||||
Install from PyPi
|
||||
-----------------
|
||||
|
||||
You can install the `mediacurator` package directly from PyPi using the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install mediacurator
|
||||
|
||||
Loading…
Reference in New Issue
Block a user