Browse Source

Update readme and changelog

Michael Ragazzon 1 year ago
parent
commit
1a348773b7
2 changed files with 13 additions and 12 deletions
  1. 5 6
      changelog.md
  2. 8 6
      readme.md

+ 5 - 6
changelog.md

@@ -16,9 +16,9 @@
 
 
 ### Prevent single pixel gaps between elements
 ### Prevent single pixel gaps between elements
 
 
-This release addresses the issue of 1px gaps appearing between fractionally sized elements when placed border-to-border. This was particularly pronounced in DPI-scaled layouts, as that often leads to fractionally sized elements. Resolves #438, see also #502.
+This release addresses the issue of 1px gaps appearing between fractionally sized elements when placed border-to-border. This was particularly pronounced in DPI-scaled layouts, as that often leads to fractionally sized elements.
 
 
-The solution involves rounding the rendered sizes of elements based on their absolute positions to ensure that the bottom/right of one element matches the top/left of the next element. This implies that the rendered size of a fractional element may vary by up to one pixel. This generally matches how web browsers behave. Floating-point precision issues may still cause rare gaps, but the improvements should cover almost all cases. See the [commit message](https://github.com/mikke89/RmlUi/commit/b197f985b328d5493af3190e27d4290bb496ff1d) for details.
+The solution involves rounding the rendered sizes of elements based on their absolute positions to ensure that the bottom/right of one element matches the top/left of the next element. This implies that the rendered size of a fractional element may vary by up to one pixel. This generally matches how web browsers behave. Floating-point precision issues may still cause rare gaps, but the improvements should cover almost all cases. See the [commit message](https://github.com/mikke89/RmlUi/commit/b197f985b328d5493af3190e27d4290bb496ff1d) for details. Resolves #438, thanks to @mwl4 for the extensive initiative and proof of concept.
 
 
 Fixes several situations with single pixel gaps and overlaps:
 Fixes several situations with single pixel gaps and overlaps:
 
 
@@ -67,14 +67,13 @@ The `<handle>` element has received several major improvements.
 
 
 ### Input elements
 ### Input elements
 
 
-- Improve navigation of `<select>` elements when using controller/keyboard navigation. #566 (thanks @Paril)
+- Improve navigation of `<select>` elements when using controller/keyboard navigation. #565 #566 (thanks @Paril)
   - Scroll to the selected options as one is moving up or down the list.
   - Scroll to the selected options as one is moving up or down the list.
   - Scroll to the selected option when opening up the selection box.
   - Scroll to the selected option when opening up the selection box.
-  - Add ability to programmatically show or hide the selection box.
+  - Add ability to programmatically [show or hide](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/element_packages/form.html#drop-down-select-box) the selection box.
 - Fix some layout and behavior issues of the `<select>` element. 
 - Fix some layout and behavior issues of the `<select>` element. 
-  - Fix some issues related to specifying the height of the select arrow element. 
+  - Fix issues related to specifying the height of the select arrow element. 
   - Fix an issue where the selection box would scroll to the top-left corner when the document layout is updated.
   - Fix an issue where the selection box would scroll to the top-left corner when the document layout is updated.
-  - 
 - Fix an issue where the contents of the `<input type="text">` and `<textarea>` elements could sometimes unintentionally scroll to a new place after a layout update.
 - Fix an issue where the contents of the `<input type="text">` and `<textarea>` elements could sometimes unintentionally scroll to a new place after a layout update.
 
 
 ### Elements
 ### Elements

+ 8 - 6
readme.md

@@ -14,17 +14,17 @@ RmlUi is the C++ user interface package based on the HTML and CSS standards, des
 
 
 RmlUi aims at being a light-weight and performant library with its own layouting engine and few dependencies. In essence, RmlUi takes your HTML/CSS-like source files and turns them into vertices, indices and draw commands, and then you bring your own renderer to draw them. And of course there is full access to the element hierarchy/DOM, event handling, and all the interactivity and customizability you would expect. All of this directly from C++, or optionally from scripting languages using plugins. The core library compiles down to fractions of the size it takes to integrate a fully fledged web browser. 
 RmlUi aims at being a light-weight and performant library with its own layouting engine and few dependencies. In essence, RmlUi takes your HTML/CSS-like source files and turns them into vertices, indices and draw commands, and then you bring your own renderer to draw them. And of course there is full access to the element hierarchy/DOM, event handling, and all the interactivity and customizability you would expect. All of this directly from C++, or optionally from scripting languages using plugins. The core library compiles down to fractions of the size it takes to integrate a fully fledged web browser. 
 
 
-RmlUi is based around the XHTML1 and CSS2 standards while borrowing features from HTML5 and CSS3, and extends them with features suited towards real-time applications. Take a look at the [conformance](#conformance) and [enhancements](#enhancements) sections below for details.
+RmlUi is based around the XHTML1 and CSS2 standards while integrating features from HTML5 and CSS3, and extends them with features suited towards real-time applications. Take a look at the [conformance](#conformance) and [enhancements](#enhancements) sections below for details.
 
 
 Documentation is located at https://mikke89.github.io/RmlUiDoc/
 Documentation is located at https://mikke89.github.io/RmlUiDoc/
 
 
 ## Features
 ## Features
 
 
-- Cross-platform architecture: Windows, macOS, Linux, iOS, etc.
+- Cross-platform architecture: Windows, Linux, macOS, Android, iOS, Switch, and more.
 - Dynamic layout system.
 - Dynamic layout system.
 - Full animation and transform support.
 - Full animation and transform support.
 - Efficient application-wide styling, with a custom-built templating engine.
 - Efficient application-wide styling, with a custom-built templating engine.
-- Fully featured control set: buttons, sliders, drop-downs, etc.
+- Fully featured control set: buttons, sliders, drop-downs, and more.
 - Runtime visual debugging suite.
 - Runtime visual debugging suite.
 
 
 ## Extensible
 ## Extensible
@@ -42,7 +42,6 @@ Documentation is located at https://mikke89.github.io/RmlUiDoc/
 - The library generates vertices, indices, and textures for the user to render how they like.
 - The library generates vertices, indices, and textures for the user to render how they like.
 - File handling and the font engine can optionally be fully replaced by the user.
 - File handling and the font engine can optionally be fully replaced by the user.
 
 
-
 ## Conformance
 ## Conformance
 
 
 RmlUi aims to support the most common and familiar features from HTML and CSS, while keeping the library light and performant. We do not aim to be fully compliant with CSS or HTML, in particular when it conflicts with lightness and performance. Users are generally expected to author documents specifically for RmlUi, but any experience and skills from web design should be transferable.
 RmlUi aims to support the most common and familiar features from HTML and CSS, while keeping the library light and performant. We do not aim to be fully compliant with CSS or HTML, in particular when it conflicts with lightness and performance. Users are generally expected to author documents specifically for RmlUi, but any experience and skills from web design should be transferable.
@@ -73,7 +72,7 @@ RmlUi adds features and enhancements over CSS and HTML where it makes sense, mos
 - [Sprite sheets](https://mikke89.github.io/RmlUiDoc/pages/rcss/sprite_sheets.html). Define and use sprites with easy high DPI support.
 - [Sprite sheets](https://mikke89.github.io/RmlUiDoc/pages/rcss/sprite_sheets.html). Define and use sprites with easy high DPI support.
 - [Templates](https://mikke89.github.io/RmlUiDoc/pages/rml/templates.html). Making windows look consistent.
 - [Templates](https://mikke89.github.io/RmlUiDoc/pages/rml/templates.html). Making windows look consistent.
 - [Localization](https://mikke89.github.io/RmlUiDoc/pages/localisation.html). Translate any text in the document.
 - [Localization](https://mikke89.github.io/RmlUiDoc/pages/localisation.html). Translate any text in the document.
-
+- [Spatial navigation](https://mikke89.github.io/RmlUiDoc/pages/rcss/user_interface.html#nav). Suitable for controllers.
 
 
 ## Dependencies
 ## Dependencies
 
 
@@ -373,7 +372,7 @@ Users can now edit the text field to change the animal. The data bindings ensure
 
 
 [Effects sample video](https://github.com/mikke89/RmlUi/assets/5490330/bdc0422d-867d-4090-9d48-e7159e3adc18)
 [Effects sample video](https://github.com/mikke89/RmlUi/assets/5490330/bdc0422d-867d-4090-9d48-e7159e3adc18)
 
 
-**[Killing Time: Resurrected](https://www.nightdivestudios.com/) by [Nightdive Studios](https://www.nightdivestudios.com/) and [Ziggurat Interactive](https://www.ziggurat.games/game/killing-time-resurrected) - remastered version of the classic shooter game - user interface made with RmlUi**\
+**[Killing Time: Resurrected](https://nightdivestudios.com/killing-time-resurrected/) by [Nightdive Studios](https://www.nightdivestudios.com/) and [Ziggurat Interactive](https://www.ziggurat.games/game/killing-time-resurrected) - remastered version of the classic shooter game - user interface made with RmlUi**\
 ![Killing Time: Resurrected collage](https://raw.githubusercontent.com/mikke89/RmlUiDoc/7ca874cc506986a789e2c9a317a4e23f359d2316/assets/gallery/killing_time_resurrected_collage.webp)
 ![Killing Time: Resurrected collage](https://raw.githubusercontent.com/mikke89/RmlUiDoc/7ca874cc506986a789e2c9a317a4e23f359d2316/assets/gallery/killing_time_resurrected_collage.webp)
 
 
 **[alt:V](https://altv.mp/) installer - a multiplayer client for GTA:V**\
 **[alt:V](https://altv.mp/) installer - a multiplayer client for GTA:V**\
@@ -395,6 +394,9 @@ Users can now edit the text field to change the animal. The data bindings ensure
 **Sandbox from the 'demo' sample, try it yourself!**\
 **Sandbox from the 'demo' sample, try it yourself!**\
 ![Sandbox](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/sandbox.png?raw=true)
 ![Sandbox](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/sandbox.png?raw=true)
 
 
+**Collage of advanced effects:**\
+![Collage of advanced effects](https://github.com/user-attachments/assets/71840d6f-903e-45fe-9e34-a02ed1ddae07)
+
 **Visual testing framework - for built-in automated layout tests**\
 **Visual testing framework - for built-in automated layout tests**\
 ![Visual testing framework](https://github.com/mikke89/RmlUiDoc/blob/c7253748d1bcf6dd33d97ab4fe8b6731a7ee3dac/assets/gallery/visual_tests_flex.png?raw=true)
 ![Visual testing framework](https://github.com/mikke89/RmlUiDoc/blob/c7253748d1bcf6dd33d97ab4fe8b6731a7ee3dac/assets/gallery/visual_tests_flex.png?raw=true)