manual wip

Author: BlackMATov

MANUAL.md

@@ -2,15 +2,15 @@
 
 ## Identifiers
 
-Identifier is a packed 40-bit integer number. The first 20 bits are the index, and the last 20 bits are the version. To create a new identifier, use the `evolved.id` function.
+Identifiers are packed 40-bit integer numbers. The first 20 bits are the index, and the last 20 bits are the version. To create a new identifier, use the `evolved.id` function.
 
 ```lua
 ---@param count? integer
 ---@return evolved.id ... ids
 function evolved.id(count) end
 ```
 
-The `count` parameter is optional and defaults to `1`. The function returns one or more identifiers, depending on the `count` parameter. Maximum number of alive identifiers is `2^20-1` (1048575). After that, the function will throw an error `"| evolved.lua | id index overflow"`.
+The `count` parameter is optional and defaults to `1`. The function returns one or more identifiers, depending on the `count` parameter. The maximum number of alive identifiers is `2^20-1` (1048575). After that, the function will throw an error: "| evolved.lua | id index overflow".
 
 Identifiers can be recycled. When an identifier is no longer needed, use the `evolved.destroy` function to destroy it. This will free up the identifier for reuse.
 
@@ -39,7 +39,7 @@ function evolved.alive_all(...) end
 function evolved.alive_any(...) end
 ```
 
-Sometimes (for debugging purposes for example), it is necessary to extract the index and version from an identifier (or pack them back). The `evolved.pack` and `evolved.unpack` functions can be used for this purpose.
+Sometimes (for debugging purposes, for example), it is necessary to extract the index and version from an identifier (or pack them back). The `evolved.pack` and `evolved.unpack` functions can be used for this purpose.
 
 ```lua
 ---@param index integer
@@ -53,7 +53,7 @@ function evolved.pack(index, version) end
 function evolved.unpack(id) end
 ```
 
-Here is an little example of how to use identifiers:
+Here is a little example of how to use identifiers:
 
 ```lua
 local evolved = require 'evolved'
@@ -70,7 +70,7 @@ assert(not evolved.alive(id)) -- check if the identifier is not alive now
 
 ## Entities, Fragments, and Components
 
-First of all, we need to understand that entities and fragments are just identifiers. The differences between them are purely semantic. Entities are used to represent objects in the world, while fragments are used to represent types of components that can be attached to entities. Components, in the other hand, are any data that is attached to entities through fragments.
+First of all, we need to understand that entities and fragments are just identifiers. The differences between them are purely semantic. Entities are used to represent objects in the world, while fragments are used to represent types of components that can be attached to entities. Components, on the other hand, are any data that is attached to entities through fragments.
 
 Here is a simple example of how to attach a component to an entity:
 
@@ -102,9 +102,9 @@ assert(evolved.get(player, stamina) == 50)
 
 We have created an entity called `player` and two fragments called `health` and `stamina`. We have attached the components `100` and `50` to the entity through our fragments. After that, we can retrieve the components using the `evolved.get` function.
 
-We'll cover the `evolved.set` and `evolved.get` functions in more detail later in the section about modifying operations. For now, let's just say that they are used to setting and getting components from entities through fragments.
+We'll cover the `evolved.set` and `evolved.get` functions in more detail later in the section about modifying operations. For now, let's just say that they are used for setting and getting components from entities through fragments.
 
-The main thing to understand here is that we can attach any data to any identifiers using another identifiers. And yes, since fragments are just identifiers, we can use them as entities too! This very useful for marking fragments with some metadata, for example.
+The main thing to understand here is that we can attach any data to any identifiers using other identifiers. And yes, since fragments are just identifiers, we can use them as entities too! This is very useful for marking fragments with some metadata, for example.
 
 ```lua
 local evolved = require 'evolved'
@@ -122,4 +122,4 @@ evolved.set(player, position, {x = 0, y = 0})
 evolved.set(player, velocity, {x = 0, y = 0})
 ```
 
-In this example, we have created a fragment called `serializable` and marked the fragments `position` and `velocity` as serializable. After that, we can write a function that will serialize entities. And this function will serialize only fragments that are marked as serializable. This is a very powerful feature of the library, and it allows us to create very flexible systems. Btw, fragments of fragments are usually called `traits`.
+In this example, we have created a fragment called `serializable` and marked the fragments `position` and `velocity` as serializable. After that, we can write a function that will serialize entities. And this function will serialize only fragments that are marked as serializable. This is a very powerful feature of the library, and it allows us to create very flexible systems. By the way, fragments of fragments are usually called `traits`.