projects: update some short descriptions
authorJean Privat <jean@pryen.org>
Fri, 28 Aug 2015 04:33:24 +0000 (00:33 -0400)
committerJean Privat <jean@pryen.org>
Fri, 28 Aug 2015 04:33:24 +0000 (00:33 -0400)
Signed-off-by: Jean Privat <jean@pryen.org>

17 files changed:
contrib/friendz/README.md
examples/circular_list.nit
examples/clock.nit
examples/clock_more.nit
examples/fibonacci.nit
examples/print_arguments.nit
examples/procedural_array.nit
examples/rosettacode/README.md
examples/shoot/README.md [new file with mode: 0644]
lib/ai/README.md
lib/cartesian.nit
lib/combinations.nit
lib/deriving.nit
lib/ordered_tree.nit
lib/scene2d.nit
lib/standard/README.md
lib/symbol.nit

index 48be94e..b30803b 100644 (file)
@@ -1,6 +1,4 @@
-Chainz of Friendz
-
-A puzzle game
+Chainz of Friendz, a multi-platform puzzle game
 
 # Objectives
 
index dd4e54d..2d1df4a 100644 (file)
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Implementation of circular lists
+# Example of an implementation of circular lists
 # This example shows the usage of generics and somewhat a specialisation of collections.
 module circular_list
 
index 811392b..3a081da 100644 (file)
@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# This module provide a simple wall clock.
-# It is an example of getters and setters.
+# Example of a simple wall clock class with generalized getters and setters.
+#
 # A beefed-up module is available in clock_more
 module clock
 
index d2ef89e..97b99c1 100644 (file)
@@ -12,8 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# This module beef up the clock module by allowing a clock to be comparable.
-# It show the usage of class refinement
+# A beefed up example of the `clock` module that show class refinement.
+#
+# It refines clock to make them comparable.
 module clock_more
 
 import clock
index e1a72c9..d4330ba 100644 (file)
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# A simple exemple of refinement where a method is added to the integer class.
+# Simple example of refinement where a method is added to the integer class.
 module fibonacci
 
 redef class Int
index 3bdddc6..1c26e06 100644 (file)
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# How to print arguments of the command line.
+# Example of how to print the arguments of the command line.
 module print_arguments
 
 for a in args do
index 838bda0..5f88218 100644 (file)
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# A procedural program (without explicit class definition).
+# Example of a procedural program (without explicit class definition).
 # This program manipulates arrays of integers.
 module procedural_array
 
index ade40c7..8527efa 100644 (file)
@@ -1,4 +1,4 @@
-# Rosetta Code
+# Various tasks from Rosetta Code
 
 This are Nit programs that solve some tasks from the [Rosetta Code] project.
 
diff --git a/examples/shoot/README.md b/examples/shoot/README.md
new file mode 100644 (file)
index 0000000..9dae94d
--- /dev/null
@@ -0,0 +1,3 @@
+A multi-platform shoot'em up in space
+
+This unfinished game is an example of the use of `mnit` and `scene2d` to develop a simple multi-platform game.
index fdb2f08..f9997e1 100644 (file)
@@ -1,4 +1,4 @@
-Simple toolkit for artificial intelligence
+Simple library for basic artificial intelligence algorithms
 
 This library provides some frameworks for basic algorithms used for artificial intelligence.
 It offers simple generic classes to extends.
index 7090050..35c65b2 100644 (file)
@@ -8,7 +8,7 @@
 # You  are  allowed  to  redistribute it and sell it, alone or is a part of
 # another product.
 
-# Cartesian products on heterogeneous collections.
+# Memory-efficient Cartesian products on heterogeneous collections.
 #
 # This module is a proof-of-concept to propose memory-efficient views on collections.
 #
@@ -19,6 +19,7 @@
 #
 # However, in Nit, there in no native *tuple* type.
 # So we need a first building block, a pair.
+module cartesian
 
 # A simple read-only pair of two elements `e` and `f`.
 class Pair[E, F]
index cb1612a..184c1ed 100644 (file)
@@ -8,7 +8,7 @@
 # You  are  allowed  to  redistribute it and sell it, alone or is a part of
 # another product.
 
-# Cartesian products, combinations and permutation on collections.
+# Memory-efficient Cartesian products, combinations and permutation on collections.
 #
 # This module offers memory-efficient views on combinatoric collections.
 # Methods of the views create objects only when needed.
index ae8394e..5a1336a 100644 (file)
@@ -8,7 +8,7 @@
 # You  are  allowed  to  redistribute it and sell it, alone or is a part of
 # another product.
 
-# Automatic derivable implementation of standard basic methods.
+# Automatic derivable implementations of standard basic methods.
 #
 # This module introduce `Derivable` as the main interface to implement (or auto-implement) and
 # provides additional mixin-interfaces with specific default behavior of standard basic methods based
index b507fb3..2a6a10c 100644 (file)
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# management and display of ordered trees
+# Manipulation and presentation of ordered trees.
 module ordered_tree
 
 # Generic structure to manage and display an ordered tree
index aa567e8..2fadd09 100644 (file)
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# 2D management of game elements
+# Framework for 2D management of game elements
 #
 # TODO: collision framework (with quad tree?)
 module scene2d
index cd780d0..7833f37 100644 (file)
@@ -1,4 +1,4 @@
-# Nit Core Library
+# Nit common library of core classes and methods
 
 Core classes and methods used by default by Nit programs and libraries.
 
index b865017..2a26fa6 100644 (file)
@@ -10,8 +10,7 @@
 # You  are  allowed  to  redistribute it and sell it, alone or is a part of
 # another product.
 
-# Symbol classes
-# FIXME: Should be deprecated soon
+# Library for simple interning of strings
 module symbol
 
 redef class String