From 114dbaf0856710a112c72fee337175a7113a2f83 Mon Sep 17 00:00:00 2001 From: Laurent Date: Thu, 19 Sep 2024 12:17:09 +0000 Subject: [PATCH] Update installation instructions in README.md and CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++++- README.md | 8 ++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d88899fbf..140e2ad01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,12 @@ We do not enforce strict rules on the design of the code, but we do have a few g We use [Rye](https://rye-up.com/guide/installation/) to manage our development environment. Please follow the instructions on the Rye website to install it. -Once Rye is installed, you can clone the repository and run `rye sync` to install the dependencies. +Once Rye is installed, you can setup your development environment by doing: +```bash +git clone "git@github.com:finegrain-ai/refiners.git" +cd refiners +rye sync --all-features +``` ## Linting diff --git a/README.md b/README.md index d826763af..7e763be1b 100644 --- a/README.md +++ b/README.md @@ -56,14 +56,14 @@ ______________________________________________________________________ ## Installation -The current recommended way to install Refiners is from source using [Rye](https://rye-up.com/): +The current recommended way to install Refiners is from source: ```bash -git clone "git@github.com:finegrain-ai/refiners.git" -cd refiners -rye sync --all-features +pip install git+https://github.com/finegrain-ai/refiners.git ``` +To setup a development environment, see [CONTRIBUTING.md](CONTRIBUTING.md). + ## Documentation Refiners comes with a MkDocs-based documentation website available at https://refine.rs. You will find there a [quick start guide](https://refine.rs/getting-started/recommended/), a description of the [key concepts](https://refine.rs/concepts/chain/), as well as in-depth foundation model adaptation [guides](https://refine.rs/guides/adapting_sdxl/).