summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMegan Wachs2021-08-30 07:36:32 -0700
committerGitHub2021-08-30 14:36:32 +0000
commit0a985f7d82d33b45bb35237bf3ca85d6f3936600 (patch)
tree6423ba64b95b03dade7e574af6a3b3d3f388cd40 /README.md
parente74b978d5188d9cd28e3520912d858d228136e75 (diff)
FIx firrtl typo in README versioning section (#2097)
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index d5ddb0fb..60d1dae9 100644
--- a/README.md
+++ b/README.md
@@ -278,7 +278,7 @@ Code that touches lots of APIs that are private to the `chisel3` package should
### Which version should I use?
-The chisel eco-system (`chisel3`, `firttl`, `dsptools`, `firrtl-interpreter`, `treadle`, `diagrammer`) use a form of semantic versioning:
+The chisel eco-system (`chisel3`, `firrtl`, `dsptools`, `firrtl-interpreter`, `treadle`, `diagrammer`) use a form of semantic versioning:
major versions are identified by two leading numbers, separated by a dot (i.e., `3.2`), minor versions by a single number following the major version, separated by a dot.
We maintain API compatibility within a major version (i.e., `3.2.12` should be API-compatible with `3.2.0`), but do not guarantee API compatibility between major versions
(i.e., APIs may change between `3.1.8` and `3.2.0`).