From 469877ca9bd01f6a5c5f1dda4e34808f4c474bac Mon Sep 17 00:00:00 2001 From: amro Date: Fri, 6 Mar 2026 23:19:41 -0500 Subject: [PATCH] Add global pip install instructions to README Signed-off-by: amro --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d079aa..9476ec5 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,16 @@ An instantiation-free python package for common matrix Lie group operations implemented as __pure static classes__. Using pure static classes keeps the usage extremely simple while still allowing for abstraction and inheritance. We do not introduce new objects with stateful behavior that must be learnt. Everything operates directly on arrays/tensors. This allows users to implement their own more sophisticated objects using these classes as back-end mathematical implementations. ## Installation -Begin by cloning this repo somewhere. To install, go to the clone directory and run +Install the package by running +```bash +pip install git+https://github.com/decargroup/pymlg +``` +Alternatively, to build an editable build, clone this repo somewhere, then go to the +directory and run +```bash pip install -e . +``` ## Documentation