From 047ab7e3b78119365f4d4066e6ac819c5860c7b1 Mon Sep 17 00:00:00 2001 From: Link <127321188+linkfrg@users.noreply.github.com> Date: Mon, 13 Jan 2025 23:52:14 +0500 Subject: [PATCH] docs: update user/installation.rst --- docs/user/installation.rst | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/user/installation.rst b/docs/user/installation.rst index 382422b7..f3dab735 100644 --- a/docs/user/installation.rst +++ b/docs/user/installation.rst @@ -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 --------------------- @@ -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