]> code.bitgloo.com Git - clyne/entityx.git/commitdiff
Clarify docs + dump test output on failure.
authorAlec Thomas <alec@swapoff.org>
Sun, 18 Aug 2013 00:43:48 +0000 (20:43 -0400)
committerAlec Thomas <alec@swapoff.org>
Sun, 18 Aug 2013 00:43:48 +0000 (20:43 -0400)
CHANGELOG.md
entityx/python/README.md
scripts/travis.sh

index ae5825582c0ec4da0a4045f1723c705f1bb15533..89c92d810c2fcc3d291e9cbf8f6b307b244b4f3b 100644 (file)
@@ -5,7 +5,6 @@
 Two big changes in this release:
 
 1. Python scripting support (alpha).
-
     - Bridges the EntityX entity-component system into Python.
     - Components and entities can both be defined in Python.
     - Systems must still be defined in C++, for performance reasons.
@@ -14,4 +13,4 @@ Two big changes in this release:
  
     See the [README](https://github.com/alecthomas/entityx/blob/master/entityx/python/README.md) for help, and the [C++](https://github.com/alecthomas/entityx/blob/master/entityx/python/PythonSystem_test.cc) and [Python](https://github.com/alecthomas/entityx/tree/master/entityx/python/entityx/tests) test source for more examples.
 
-2. Updated the build system to 
+2. Made the build system much more robust, including automatic feature selection with manual override.
index be543fb415b5411a64d3b80901f73eb46c94387c..f4f6aa2231bbac75d2cd2c3655e71f6cc1ba00b6 100644 (file)
@@ -8,13 +8,16 @@ Planned features that are currently unimplemented:
 
 - Emitting events from Python.
 
-## Concepts
+## Design
 
 - Python scripts are attached to entities with `PythonComponent`.
+- Systems and components can not be created from Python, primarily for performance reasons.
 - Events are proxied directly to Python entities via `PythonEventProxy` objects.
+    - Each event to be handled in Python must have an associated `PythonEventProxy`implementation.
+    - As a convenience `BroadcastPythonEventProxy<Event>(handler_method)` can be used. It will broadcast events to all `PythonComponent` entities with a `<handler_method>`.
 - `PythonSystem` manages scripted entity lifecycle and event delivery.
 
-## Overview
+## Summary
 
 To add scripting support to your system, something like the following steps should be followed:
 
index 3244b82c5f7263ab4997f03a4304fd1c6bb319f3..dadc478d33b9eaf189b3459d238c0609ad74132e 100755 (executable)
@@ -12,4 +12,4 @@ fi
 
 cmake ${CMAKE_ARGS}
 make VERBOSE=1
-make test
+make test || cat Testing/Temporary/LastTest.log