From 5555559643d6196c1bf7a124e8ceb4564873185f Mon Sep 17 00:00:00 2001 From: Fabrice Normandin Date: Thu, 7 Nov 2024 10:03:12 -0500 Subject: [PATCH] Add some install instructions and a link in README (#86) Signed-off-by: Fabrice Normandin --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a7f9f2f1..98ab5d2d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,16 @@ The main target audience is [Mila](https://mila.quebec/en) researchers and stude For more context, see [this introduction to the project.](https://mila-iqia.github.io/ResearchTemplate/intro). +## Installation + +Projects created with this template use [uv](https://docs.astral.sh/uv/) to manage dependencies. Once you have `uv` installed locally, you can install all dependencies with a single command: + +```bash +uv sync # Creates a virtual environment and installs dependencies in it. +``` + +For more detailed instructions, take a look at [this page](https://mila-iqia.github.io/ResearchTemplate/#setting-up-your-environment) of the template docs. + ## Overview This project makes use of the following libraries: