Skip to content

Commit

Permalink
Added note about versioning (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
robgjansen authored May 4, 2023
1 parent 570d5b4 commit 9f8107b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ Here is a bibtex entry for latex users:
}
```

### Note about versioning

Development of tornettools is slow and typically focuses on changes that keep the tool in
sync with changes being made in Shadow. Thus, you should generally just ignore the tornettools
version numbers and use the latest version. Sometimes you might want to pin to a specific
version that is known to be compatible with your version of Shadow, e.g., when building
container images, and in this case we recommend pinning to a specific commit hash.

We do use version numbers, but they have historically been based on vibes rather than semver
and we don't want to introduce the overhead of following a more strict policy than that.

### setup is easy with virtualenv and pip

python3 -m venv toolsenv
Expand Down

0 comments on commit 9f8107b

Please sign in to comment.