Skip to content

Commit

Permalink
README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
zhubonan committed Jun 27, 2023
1 parent 61b794a commit 4edb92f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Commands:
```

### Developer Installation (from source)

A recent version of `pip` is needed to do this, due to the new style of the `pyproject.toml` configuration
file.
To upgrade your `pip`, do:
Expand All @@ -89,9 +90,12 @@ pip install -U pip
Assuming the package is in the `easyunfold` folder, use the following command to install:

```
pip install ./easyunfold
pip install "./easyunfold[test,doc,pre-commit]"
```

which also installs additional dependencies for building documentation (`doc`), running tests (`test`) and
dependencies for using pre-commit hooks (`pre-commit`).

## Studies using `easyunfold`

We'll add papers that use `easyunfold` to this list as they come out!
Expand Down

0 comments on commit 4edb92f

Please sign in to comment.