From 460aa5cbd5fcd1105ea3bef55e8eb9b64bc5fd21 Mon Sep 17 00:00:00 2001 From: Trevor Slocum Date: Thu, 15 Oct 2020 11:49:50 -0700 Subject: [PATCH] Add compatibility warning --- FORK.md | 3 ++- README.md | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/FORK.md b/FORK.md index 9108790..f8ad2c7 100644 --- a/FORK.md +++ b/FORK.md @@ -79,7 +79,8 @@ This is in preparation for supporting tabbed panels. ## `Application.ForceDraw` has been removed Because cview is [thread-safe](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#hdr-Concurrency), -forcing an application draw is no longer possible, nor required. +application draws must be queued. Call `Application.QueueUpdateDraw` to queue +an update that requires the application to be drawn when completed. # Merged pull requests diff --git a/README.md b/README.md index 08646a3..89965ad 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ This package is a fork of [tview](https://github.com/rivo/tview). See [FORK.md](https://gitlab.com/tslocum/cview/blob/master/FORK.md) for more information. +**Warning:** Breaking changes may be added to cview without bumping its major +version. The largest changes have been made. Smaller breaking changes may +continue to be made where backwards compatibility is not possible. Changes are +listed in [FORK.md](https://gitlab.com/tslocum/cview/blob/master/FORK.md). + ## Demo `ssh cview.rocketnine.space -p 20000`