Add a system where themes can present a simple menu to the user.

[nageru] / README

diff --git a/README b/README
index 62c2471be12cac740bf88458a8a33651123d8f42..e153119b48c08981d9c7e217c3630a2c87b80370 100644 (file)
--- a/README
+++ b/README
@@ -22,6 +22,9 @@ Features:
    pipelines, running transitions etc., so that the visual look is
    consistent between operators.
 
+ - HTML rendering (through Chromium Embedded Framework), for high-quality
+   and flexible overlay or other graphics.
+
  - Comprehensive monitoring through Prometheus metrics.
 
 [1] For reference, that is: Core i7 4600U (dualcore 2.10GHz, clocks down
@@ -30,7 +33,7 @@ to 800 MHz after 30 seconds due to thermal constraints), Intel HD Graphics
 (so 12.8 GB/sec theoretical memory bandwidth, shared between CPU and GPU).
 
 
-Nageru is in beta stage. It currently needs:
+Nageru currently needs:
 
  - An Intel processor with Intel Quick Sync, or otherwise some hardware
    H.264 encoder exposed through VA-API. Note that you can use VA-API over
@@ -61,8 +64,7 @@ Nageru is in beta stage. It currently needs:
  - Working OpenGL; Movit works with almost any modern OpenGL implementation.
    Nageru has been tested with Intel on Mesa (you want 11.2 or newer, due
    to critical stability bugfixes), and with NVIDIA's proprietary drivers.
-   AMD's proprietary drivers (fglrx) are known not to work due to driver bugs;
-   I am in contact with AMD to try to get this resolved.
+   The status of AMD's proprietary drivers is currently unknown.
 
  - libzita-resampler, for resampling sound sources so that they are in sync
    between sources, and also for oversampling for the peak meter.
@@ -71,6 +73,16 @@ Nageru is in beta stage. It currently needs:
 
  - libpci, for printing friendly PCI device names in an error message.
 
+ - Optional: CEF (Chromium Embedded Framework), for HTML graphics.
+   If you build without CEF, the HTMLInput class will not be available from
+   the theme. You can get binary downloads of CEF from
+
+     http://opensource.spotify.com/cefbuilds/index.html
+
+   Simply download the right build for your platform (the “minimal” build
+   is fine) and add CEF_DIR=<path>/cef_binary_X.XXXX.XXXX.XXXXXXXX_linux64
+   on the make command line (substituting X with the real version as required).
+
 
 If on Debian stretch or something similar, you can install everything you need
 with:
@@ -82,12 +94,14 @@ with:
     libasound2-dev libx264-dev libbmusb-dev protobuf-compiler \
     libprotobuf-dev libpci-dev
 
-Exceptions as of July 2017:
+Exceptions as of February 2018:
 
   - You will need Movit from unstable; stretch only has 1.4.0.
 
   - You will need bmusb from unstable; stretch only has 0.5.4.
 
+  - Debian does not carry CEF (but it is optional).
+
 The patches/ directory contains a patch that helps zita-resampler performance.
 It is meant for upstream, but was not in at the time Nageru was released.
 It is taken to be by Steinar H. Gunderson <sesse@google.com> (ie., my ex-work
@@ -135,7 +149,7 @@ give up, but that's not the intended meaning.)
 
 
 Nageru's home page is at https://nageru.sesse.net/, where you can also find
-contact information and link to the latest version.
+contact information, full documentation and link to the latest version.
 
 
 Legalese: TL;DR: Everything is GPLv3-or-newer compatible, and see