summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2026-01-20 21:57:17 +0200
committerDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2026-01-22 16:30:10 +0200
commit80a557fd00b887521c7c77feef0134434912b3df (patch)
tree48e929fdd569aa1acbf9cf3d500a04fd43fd7f84 /README.org
parentfcd74be338b7ed1b4398a76422e07ff3e0630339 (diff)
build: bump to 1.14.0-pre1, bump some required versions
Bump the required versions of some libraries / emacs slightly so we can get rid of some special-casing and work-arounds. These are mostly based on Ubuntu 24.04 LTS, which is rather conservative; so should hopefully not inconvenience any users. - compiler: we now require C++20 instead of C++17 - glib & friends: 2.60 => 2.80 - xapian: 1.4 => 1.4.22 - emacs 26.3 => 28.1 Ubuntu 24.04 actually has Emacs 29.3, but that'd perhaps be too big a jump.
Diffstat (limited to 'README.org')
-rw-r--r--README.org26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.org b/README.org
index f33a3b4..57f4e52 100644
--- a/README.org
+++ b/README.org
@@ -45,14 +45,22 @@ version 3]] (or higher).
* Versions
-*mu* attempts to balance development speed and stability. For this, every few
-months there is a stable version (e.g. ~1.12.12~); development then continues in
-in ~master~, with ~-pre<n>~ (e.g. ~1.12.14-pre3~): ~-pre~-suffixed versions refer to the
-current _development_ code, until it is released (and then looses its ~-pre~ suffix,
-i.e., becomes the ~1.12.14~ release).
+*mu* attempts to balance development speed and stability.
-So if you want stability, grab the [[https://github.com/djcb/mu/releases/][release]]; if you are more
-adventurous/impatient, git ~master~ is there as well.
+Active development takes place on ~master~ (the 1.14 series), and we maintain
+~release/1.12~ as well. When possible, fixes (but not features) from ~master~ are
+back-ported to ~release/1.12~.
+
+Every few months, we release a stable version (e.g. ~1.14.0~); development then
+continues in ~master~, with ~-pre<n>~ (e.g. ~1.14.1-pre1~): ~-pre~-suffixed versions
+refer to the current _development_ code, until it is released (and then looses its
+~-pre~ suffix, i.e., becomes the ~1.14.1~ release).
+
+Hence, if you want to track active development, use ~master~; if you want to avoid
+any changes except bug-fixes, use a 1.12 [[https://github.com/djcb/mu/releases/][release]]; otherwise, track ~master~.
+
+Overall, we try to avoid incompatible changes, but sometimes this is necessary,
+for example to update the versions of required libraries
* Installation
@@ -66,13 +74,13 @@ as a Linux distribution. Many have packages available.
To be able to build ~mu~, ensure you have:
-- a C++17 compiler (~gcc~ and ~clang~ are known to work)
+- a C++20 compiler (~gcc~ and ~clang~ are known to work)
- development packages for /Xapian/ and /GMime/ and /GLib/ (see ~meson.build~ for the
versions)
- basic tools such as ~make~, ~sed~, ~grep~
- ~meson~
-For ~mu4e~, you also need ~emacs~.
+For ~mu4e~, you also need ~emacs~, version 28 or later.
Note, support for Windows is very much _experimental_, that is, it works for some
people, but we can't really support it due to lack of the specific expertise.