Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SkypLabs committed Dec 13, 2024
1 parent 82c1c95 commit ee9057e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/development/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To install the dependencies in `docs`:

::

pip3 install .[docs]
pip install .[docs]


Build the documentation
Expand Down
25 changes: 20 additions & 5 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,22 @@ Installation
From PyPI (recommended)
-----------------------

::
To install Faker Wi-Fi ESSID from `PyPI`_ with pip:

pip3 install --upgrade faker-wifi-essid
.. code:: sh
pip install --upgrade faker-wifi-essid
However, as Faker Wi-Fi ESSID is a programming library (a `module <Python
Modules>`_ in Python parlance), it is most likely to be added as a dependency
to the `pyproject.toml` file of your project or its equivalent configuration
file:

.. code:: toml
dependencies = [
"faker_wifi_essid",
]
From sources
------------
Expand All @@ -17,10 +30,12 @@ Faker Wi-Fi ESSID is packaged with `Setuptools`_.
The default Git branch is `develop`. To install the latest stable version, you
need to clone the `main` branch.

::
.. code:: sh
git clone -b main git@github.com:SkypLabs/faker-wifi-essid.git
git clone -b main https://github.com/SkypLabs/faker-wifi-essid.git
cd faker-wifi-essid
pip3 install .
pip install .
.. _Python Modules: https://docs.python.org/3/tutorial/modules.html
.. _PyPI: https://pypi.org/
.. _Setuptools: https://pypi.org/project/setuptools/

0 comments on commit ee9057e

Please sign in to comment.