From 496515f94a79dfa40129502cb81db670331d78e4 Mon Sep 17 00:00:00 2001 From: a <4184070+MrCurtis@users.noreply.github.com> Date: Sat, 27 Jan 2024 00:45:29 +0000 Subject: [PATCH] Add note about editable installs --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6f07b13..aaaed25 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,19 @@ To install: ``` pip install fk-graph ``` + +Development: +------------ + +Clone the repo and `cd` in to the project directory. Create a virtual env, then install +the requirements with + +``` +pip install -r requirements.txt +``` + +Finally, to be able to run tests while developing, install the package as an editable install. + +``` +pip install --editable . +```