Browse Source

Update changelog and readmes.

Michael Ragazzon 5 years ago
parent
commit
7bcef8ee0a
5 changed files with 87 additions and 39 deletions
  1. 33 33
      Samples/readme.md
  2. 0 3
      Tests/Output/Readme.txt
  3. 42 0
      Tests/readme.md
  4. 11 1
      changelog.md
  5. 1 2
      readme.md

+ 33 - 33
Samples/readme.md

@@ -1,42 +1,42 @@
 ## RmlUi Sample Applications
 
-This directory contains a collection of sample applications that demonstrate the 
-use of RmlUi in small, easy to understand applications.
+This directory contains a collection of sample applications that demonstrate the use of RmlUi in small, easy to understand applications.
 
 ### Directory Overview
 
-```
- * assets      - This directory contains the assets shared by
-                 all the sample applications.
- * basic       - This directory contains basic applications
-                 that demonstrate initialisation, usage, shutdown 
-                 and installation of custom interfaces.
-               
-                 * animation    - animations and transitions
-                 * benchmark    - a benchmark to measure performance
-                 * bitmapfont   - using a custom font engine
-                 * customlog    - setting up custom logging
-                 * demo         - demonstrates a variety of features in RmlUi and
-                                  includes a sandbox for playing with RML/RCSS
-                 * drag         - dragging elements between containers
-                 * loaddocument - loading your first document
-                 * sdl2         - integrating with SDL2
-                 * sfml2        - integrating with SFML2
-                 * transform    - demonstration of transforms
-                 * treeview     - using a nested DataSource
+#### `assets`
+
+This directory contains the assets shared by all the sample applications.
+
+#### `basic`
+
+This directory contains basic applications that demonstrate initialisation, usage, shutdown and installation of custom interfaces.
+ 
+-  `animation` animations and transitions
+-  `benchmark` a benchmark to measure performance
+-  `bitmapfont` using a custom font engine
+-  `customlog` setting up custom logging
+-  `databinding` setting up and using data bindings
+-  `demo` demonstrates a variety of features in RmlUi and includes a sandbox for playing with RML/RCSS
+-  `drag` dragging elements between containers
+-  `loaddocument` loading your first document
+-  `sdl2` integrating with SDL2
+-  `sfml2` integrating with SFML2
+-  `transform` demonstration of transforms
+-  `treeview` using data bindings to create a file browser
                
- * invaders    - A full implementation of the 1970s classic
-                 Space Invaders using the RmlUi interface.
+#### `invaders`
+
+A full implementation of the 1970s classic Space Invaders using the RmlUi interface.
                
- * luainvaders - Lua version of the invaders sample. Only installed
-                 with the Lua plugin.
+#### `luainvaders`
+
+Lua version of the invaders sample. Only installed with the Lua plugin.
                
- * shell       - Common platform specific code used by all the 
-                 samples for open windows, processing input and 
-                 access files.
-                 Supports Windows, macOS and Linux
+#### `shell`
+
+Common platform specific code used by all the samples for open windows, processing input and access files. Supports Windows, macOS and Linux.
                
- * tutorial    - Tutorial code that should be used in conjunction
-                 with the tutorials on the RmlUi website.
-                 https://mikke89.github.io/RmlUiDoc/
-```
+#### `tutorial`
+
+Tutorial code that should be used in conjunction with the tutorials in the [RmlUi documentation](https://mikke89.github.io/RmlUiDoc/).

+ 0 - 3
Tests/Output/Readme.txt

@@ -1,3 +0,0 @@
-By default, the VisualTests suite will output screenshots and diff images into this directory, and read previous screenshots from this directory.
-
-Use the CMake options VISUAL_TESTS_OUTPUT_DIRECTORY and VISUAL_TESTS_INPUT_DIRECTORY to specify other directories.

+ 42 - 0
Tests/readme.md

@@ -0,0 +1,42 @@
+## RmlUi Test Suite
+
+This directory contains tests and benchmarks for RmlUi. They have been separated into three projects located under the `Source` directory. These projects can be enabled using the CMake options `BUILD_TESTING`.
+
+
+#### Visual tests
+
+For visually testing the layout engine in particular, with small test documents that can be easily added. Includes features for capturing and comparing tests for easily spotting differences during development. A conversion script for the CSS 2.1 tests is available as described below.
+
+#### Unit tests
+
+To ensure smaller units of the library are working properly.
+
+#### Benchmarks
+
+Benchmarking various components of the library to keep track of performance increases or regressions for future development, and find any performance hotspots that could need extra attention.
+
+
+
+### Directory Overview
+
+#### `Data`
+
+This directory contains the shared style sheets and documents, as well as the source documents for the included visual tests. All documents located under `Data/VisualTests/` will automatically be loaded by the visual tests project.
+
+#### `Dependencies`
+
+This directory contains additional libraries used by the test suite.
+
+#### `Output`
+
+By default, the visual tests will output screenshots and diff images into this directory, and read previous screenshots from this directory.
+
+Use the CMake options `VISUAL_TESTS_OUTPUT_DIRECTORY` and `VISUAL_TESTS_INPUT_DIRECTORY` to specify other directories.
+
+#### `Source`
+
+Source code for the test suite.
+               
+#### `Tools`
+
+Includes a best-effort conversion script for the [CSS 2.1 tests](https://www.w3.org/Style/CSS/Test/CSS2.1/), which includes thousands of tests, to RML/RCSS for testing conformance with the CSS specifications.

+ 11 - 1
changelog.md

@@ -46,7 +46,7 @@ The Lua plugins have been changed to reflect the above changes.
 - Refactored `TransformPrimitive.h` by moving utility functions that should only be used internally to an internal header file.
 - Renamed header guard macros.
 
-### Model-view-controller (MVC) implementation
+### Data bindings (model-view-controller)
 
 RmlUi now supports a model-view-controller (MVC) approach through data bindings. This is a powerful approach for making documents respond to data changes, or in reverse, updating data based on user actions.
 
@@ -136,6 +136,12 @@ Improved Lua plugin in several aspects.
 - Lua error reporting improvements, including stack trace. [#140](https://github.com/mikke89/RmlUi/pull/140) [#151](https://github.com/mikke89/RmlUi/pull/151) (thanks @actboy168)
 - Add support for declaring data bindings. [#146](https://github.com/mikke89/RmlUi/pull/146)  [#150](https://github.com/mikke89/RmlUi/pull/150) (thanks @cloudwu and @actboy168)
 
+### Samples
+
+- New `databinding` sample for demonstrating data bindings.
+- The use of `datagrid` in sample projects has now been replaced with data bindings. This includes the `treeview` sample and the high scores document in the `invader` sample. Tutorials have not been updated.
+- The options document in the `luainvader` sample now demonstrate data bindings combined with Lua scripts.
+
 ### Other features and improvements
 
 - Added `Rml::GetTextureSourceList()` function to list all image sources loaded in all documents. [#131](https://github.com/mikke89/RmlUi/issues/131)
@@ -156,6 +162,10 @@ Improved Lua plugin in several aspects.
 - Fix \<textarea\> getting an unnecessary horizontal scrollbar. [#122](https://github.com/mikke89/RmlUi/issues/122)
 - Fix text-decoration not always being regenerated. [#119](https://github.com/mikke89/RmlUi/issues/119)
 
+### Deprecated functionality
+
+- The `datagrid` element and related functionality has been deprecated in favor of [data bindings](https://mikke89.github.io/RmlUiDoc/pages/data_bindings.html) and [RCSS tables](https://mikke89.github.io/RmlUiDoc/pages/rcss/tables.html).
+
 ### Breaking changes
 
 - Namespaces and plugin names changed! See the restructuring changes above.

+ 1 - 2
readme.md

@@ -143,7 +143,6 @@ body
 
 ## Gallery
 
-
 ![Game interface](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/invader.png)
 **Game interface from the 'invader' sample**
 
@@ -165,7 +164,7 @@ body
 ![Lottie animation](https://github.com/mikke89/RmlUiDoc/blob/086385e119f0fc6e196229b785e91ee0252fe4b4/assets/gallery/lottie.gif)  
 **Vector animations with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html)**
 
-To see more examples of animations and transitions in action, have a look at the videos in the [animations documentation](https://mikke89.github.io/RmlUiDoc/pages/rcss/animations_transitions_transforms.html).
+To see more screenshots and videos of the library in action, have a look at the [full gallery](https://mikke89.github.io/RmlUiDoc/pages/gallery.html) in the documentation.