Skip to content

Commit

Permalink
Improve clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
tovrstra committed Oct 28, 2024
1 parent 4e09d01 commit 5065246
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ pip install tinyff
Code written for TinyFF 1 can be easily updated to work with TinyFF 2.
All required changes are documented in the [Migration Guide](migration.md).

A complete list of changes is documented in [CHANGELOG.md](CHANGELOG.md).
A complete list of changes can be found in [CHANGELOG.md](CHANGELOG.md).


## Features
Expand Down
3 changes: 1 addition & 2 deletions migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Minor versions upgrades should maintain backward compatibility.
Only when the major version changes, you may need to make changes to code using TinyFF


## Upgrading from TinyFF 1.x to 2.x
## Upgrading from TinyFF 1 to 2

The required changes are relatively minor:

Expand Down Expand Up @@ -59,7 +59,6 @@ The required changes are relatively minor:
- The pair potentials have undergone a similar change.
If you want to calculate the derivative, you need to ask for it explicitly.
By default, only the energy is computed.
(They are now all derived from `PairwiseTerm` instead of `PairPotential`)
For example, change from:

```python
Expand Down

0 comments on commit 5065246

Please sign in to comment.