Added documentation about Pypi availability and installation

This commit is contained in:
hakril
2020-07-23 10:19:55 +02:00
parent 2cd9c287aa
commit caa8ef5f32
5 changed files with 40 additions and 19 deletions
+8 -1
View File
@@ -22,7 +22,14 @@ I am always glad to have feedbacks from people using this project.
## Installation
You can install PythonForWindows using the ``setup.py`` script:
PythonForWindows is available on [Pypi](https://pypi.org/project/PythonForWindows/) an this can be installed with
``
python -m pip install PythonForWindows
``
You can also install PythonForWindows by cloning it and using the ``setup.py`` script:
``
python setup.py install
+10 -5
View File
@@ -27,17 +27,22 @@ Examples are available on the `github page <https://github.com/hakril/pythonforw
Installation
''''''''''''
Installing from Pypi
^^^^^^^^^^^^^^^^^^^^
PythonForWindows is available on `Pypi <https://pypi.org/project/PythonForWindows/>`_ an this can be installed with::
python -m pip install PythonForWindows
Installing using setup.py
^^^^^^^^^^^^^^^^^^^^^^^^^
You can install PythonForWindows using the ``setup.py`` at the root of the project::
You can also install PythonForWindows by cloning it and using the ``setup.py`` at the root of the project::
python setup.py install
.. warning::
PythonForWindows is not available on Pypi for now and thus cannot be directly installed using ``pip``.
Python3
^^^^^^^
+11 -7
View File
@@ -57,15 +57,18 @@ I am always glad to have feedbacks from people using this project.</p>
<p>Examples are available on the <a class="reference external" href="https://github.com/hakril/pythonforwindows#pythonforwindows">github page</a> and in the <a class="reference internal" href="sample.html#sample-of-code"><span class="std std-ref">Samples of code</span></a>.</p>
<div class="section" id="installation">
<h3>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h3>
<div class="section" id="installing-using-setup-py">
<h4>Installing using setup.py<a class="headerlink" href="#installing-using-setup-py" title="Permalink to this headline"></a></h4>
<p>You can install PythonForWindows using the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> at the root of the project:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
<div class="section" id="installing-from-pypi">
<h4>Installing from Pypi<a class="headerlink" href="#installing-from-pypi" title="Permalink to this headline"></a></h4>
<p>PythonForWindows is available on <a class="reference external" href="https://pypi.org/project/PythonForWindows/">Pypi</a> an this can be installed with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">PythonForWindows</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">PythonForWindows is not available on Pypi for now and thus cannot be directly installed using <code class="docutils literal notranslate"><span class="pre">pip</span></code>.</p>
</div>
<div class="section" id="installing-using-setup-py">
<h4>Installing using setup.py<a class="headerlink" href="#installing-using-setup-py" title="Permalink to this headline"></a></h4>
<p>You can also install PythonForWindows by cloning it and using the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> at the root of the project:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">install</span>
</pre></div>
</div>
</div>
<div class="section" id="python3">
@@ -241,6 +244,7 @@ Do not hesitate report bugs and issues.</p>
<li><a class="reference internal" href="#">Welcome to PythonForWindowss documentation!</a><ul>
<li><a class="reference internal" href="#description">Description</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#installing-from-pypi">Installing from Pypi</a></li>
<li><a class="reference internal" href="#installing-using-setup-py">Installing using setup.py</a></li>
<li><a class="reference internal" href="#python3">Python3</a></li>
</ul>
+1 -1
View File
File diff suppressed because one or more lines are too long
+10 -5
View File
@@ -27,17 +27,22 @@ Examples are available on the `github page <https://github.com/hakril/pythonforw
Installation
''''''''''''
Installing from Pypi
^^^^^^^^^^^^^^^^^^^^
PythonForWindows is available on `Pypi <https://pypi.org/project/PythonForWindows/>`_ an this can be installed with::
python -m pip install PythonForWindows
Installing using setup.py
^^^^^^^^^^^^^^^^^^^^^^^^^
You can install PythonForWindows using the ``setup.py`` at the root of the project::
You can also install PythonForWindows by cloning it and using the ``setup.py`` at the root of the project::
python setup.py install
.. warning::
PythonForWindows is not available on Pypi for now and thus cannot be directly installed using ``pip``.
Python3
^^^^^^^