Skip to content

Commit

Permalink
Update installation instructions in README.md and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurent2916 committed Sep 19, 2024
1 parent 73089a4 commit 114dbaf
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down

0 comments on commit 114dbaf

Please sign in to comment.