]> code.bitgloo.com Git - clyne/entityx.git/commitdiff
README formatting tweaks.
authorAlec Thomas <alec@swapoff.org>
Mon, 14 Oct 2013 17:56:17 +0000 (13:56 -0400)
committerAlec Thomas <alec@swapoff.org>
Mon, 14 Oct 2013 17:56:17 +0000 (13:56 -0400)
README.md

index 7be4eb724b409f021f1062d3c50659424d951ef5..b5addbb9ad61088562d06d8fe30d025b7b74c8b8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -58,11 +58,11 @@ entity.destroy();
 
 #### Implementation details
 
-- Each entityx::Entity is a convenience class wrapping an entityx::Entity::Id.
-- An entityx::Entity handle can be invalidated with `invalidate()`. This does not affect the underlying entity.
-- When an entity is destroyed the manager adds its ID to a free list and invalidates the entityx::Entity handle.
+- Each `entityx::Entity` is a convenience class wrapping an `entityx::Entity::Id`.
+- An `entityx::Entity` handle can be invalidated with `invalidate()`. This does not affect the underlying entity.
+- When an entity is destroyed the manager adds its ID to a free list and invalidates the `entityx::Entity` handle.
 - When an entity is created IDs are recycled from the free list before allocating new ones.
-- An entityx::Entity ID contains an index and a version. When an entity is destroyed, the version associated with the index is incremented, invalidating all previous entities referencing the previous ID.
+- An `entityx::Entity` ID contains an index and a version. When an entity is destroyed, the version associated with the index is incremented, invalidating all previous entities referencing the previous ID.
 - EntityX uses a reference counting smart pointer`entityx::ptr<T>` to manage object lifetimes. As a general rule, passing a pointer to any EntityX method will convert to a smart pointer and take ownership. To maintain your own reference to the pointer you will need to wrap it in `entityx::ptr<T>`.
 
 ### Components (entity data)