docs: add installing from source instructions to contributing guide (#…

…236) * Improve the contributing documentation by adding the installation procedure * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Erik Bjäreholt <[email protected]>
ErikBjare · Oct 31, 2024 · 4665f49 · 4665f49
1 parent e77cd4e
commit 4665f49
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -9,6 +9,28 @@ We welcome contributions to the project. Here is some information to get you sta
 .. contents::
    :local:
 
+Install
+-------
+
+.. code-block:: bash
+
+   # checkout the code and navigate to the root of the project
+   git clone https://github.com/ErikBjare/gptme.git
+   cd gptme
+   
+   # install poetry (if not installed)
+   pipx install poetry
+   
+   # activate the virtualenv
+   poetry shell
+
+   # build the project
+   make build
+
+You can now start ``gptme`` from your development environment using the regular commands.
+
+You can also install it in editable mode with ``pipx`` using ``pipx install -e .`` which will let you use your development version of gptme regardless of venv.
+
 Tests
 -----