aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEric Biggers <ebiggers@google.com>2023-01-30 22:59:20 -0800
committerEric Biggers <ebiggers@google.com>2023-01-30 22:59:20 -0800
commita72760aa794e7714496074a0264314d26fa3b4c8 (patch)
treead9b6cb0a78813e522ecef471a8a7cb7800a82e4 /README.md
parentd7ec9dc02acaf6bfd6c79928eb665506c4b6c63c (diff)
Add a NEWS file
Copy the GitHub release notes into a NEWS.md file so that the release notes are included in the actual git repo. This way, they aren't hidden away in GitHub, where they require an internet connection to access and will be lost if GitHub ever goes away. This also makes the release notes be properly versioned; GitHub allows past release notes to be edited, and there doesn't seem to be any record of what changed. Finally, this allows packages to install the release notes into /usr/share/doc/$pkgname/, as is the usual convention.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5a8b98e..79032bc 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,8 @@ Only certain filesystems, such as [ext4](https://en.wikipedia.org/wiki/Ext4) and
of supported filesystems and how to enable encryption support on each one, see
[Runtime dependencies](#runtime-dependencies).
+For the release notes, see the [NEWS file](NEWS.md).
+
## Table of contents
- [Alternatives to consider](#alternatives-to-consider)