Skip to content

Commit

Permalink
docs: update user/installation.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
linkfrg committed Jan 13, 2025
1 parent 5ab7826 commit 047ab7e
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion docs/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,40 @@ Then add the following to ``environment.systemPackages`` or ``home.packages``:
inputs.ignis.packages.${system}.ignis
Pip
----

Pip is the standard package manager for Python.
You can install Ignis directly from the Git repository using Pip.

.. hint::

You can do this in a Python virtual environment.
Create and activate one with the following commands:

.. code-block:: bash
python -m venv venv
source venv/bin/activate # for fish: . venv/bin/activate.fish
To install the latest (Git) version of Ignis:

.. code-block:: bash
pip install git+https://github.com/linkfrg/ignis.git
To install a specific version (e.g., ``v0.5``):

.. code-block:: bash
# replace "TAG" with the desired Git tag
pip install git+https://github.com/linkfrg/ignis.git@TAG
.. seealso::

For advanced usage, you can `set up a development environment <../dev/env.html>`_ and install Ignis in editable mode.
This allows you to easily switch between commits, versions, branches, or pull requests using `git`, without having to reinstall Ignis.

Building from source
---------------------

Expand All @@ -66,7 +100,7 @@ Building from source
git clone https://github.com/linkfrg/ignis.git
cd ignis
meson setup build --prefix=/usr --libdir "lib/ignis"
meson setup build --prefix=/usr
meson compile -C build
meson install -C build
Expand Down

0 comments on commit 047ab7e

Please sign in to comment.