Finegrain/refiners
1
0
Fork 0
mirror of https://github.com/finegrain-ai/refiners.git synced 2024-11-09 23:12:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update installation instructions in README.md and CONTRIBUTING.md

Browse source
This commit is contained in:
Laurent 2024-09-19 12:17:09 +00:00
parent 73089a4e2d
commit 114dbaf085
No known key found for this signature in database
2 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -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

8
README.md
View file

@ -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/).