Skip to content

Commit

Permalink
Add some install instructions and a link in README (#86)
Browse files Browse the repository at this point in the history
Signed-off-by: Fabrice Normandin <normandf@mila.quebec>
  • Loading branch information
lebrice authored Nov 7, 2024
1 parent bc5723f commit 5555559
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 5555559

Please sign in to comment.