Added the gpl

[flatland.git] / README.md

diff --git a/README.md b/README.md
index e2d8a9d..82dcf74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 This is an implementation of a simple 2d physics simulator usable from
 the pytorch framework.
 
-The core provided function is
+The main function is
 
 ```
 torch.ByteTensor generate_sequence(bool pulling,
@@ -11,23 +11,24 @@ torch.ByteTensor generate_sequence(bool pulling,
                                    int nb_images,
                                    int image_height, int image_width,
                                    int nb_shapes,
-                                   bool random_shape_size, bool random_colors) {
+                                   bool random_shape_size, bool random_colors)
 ```
-with
 
- * `pulling` indicating if one of the shape should be pulled upward,
- * `nb_sequences` the number of sequences to generate
- * `nb_images` the number of frames per sequence
- * `image_height` an `image_width` the individual image size
- * `nb_shapes` how many rectangular shapes to put in the simulation
- * `random_shape_size` should they be of different size
- * `random_colors` should they be of different colors
+where
+
+ * `pulling` indicates if one of the shape should be pulled upward,
+ * `nb_sequences` is the number of sequences to generate,
+ * `nb_images` is the number of frames per sequence,
+ * `image_height` and `image_width` is the individual image size,
+ * `nb_shapes` is the number of rectangular shapes in the simulation,
+ * `random_shape_size` states if the shapes should be of different sizes,
+ * `random_colors` states if they should be of different colors.
 
 The returned ByteTensor has five dimensions:
 
  * Sequence index
  * Image index
- * Channel (3, as for RGB)
+ * Channel (3 since it is RGB)
  * Pixel row
  * Pixel col