contrib: update the README of many contribs
authorAlexis Laferrière <alexis.laf@xymus.net>
Fri, 28 Aug 2015 17:53:17 +0000 (13:53 -0400)
committerAlexis Laferrière <alexis.laf@xymus.net>
Sat, 29 Aug 2015 00:05:28 +0000 (20:05 -0400)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

contrib/benitlux/README.md
contrib/inkscape_tools/README.md
contrib/jwrapper/README.md
contrib/pep8analysis/README.md
contrib/physical_interface_for_mpd_on_rpi/physical_interface_for_mpd_on_rpi.nit
contrib/rss_downloader/README.md
contrib/sort_downloads/README.md
contrib/tnitter/README.md

index db4c127..6f4ce46 100644 (file)
@@ -1,4 +1,4 @@
-Benitlux is an unofficial mailing list to keep faithful bargoers informed of the current beer offer at the excellent Brasserie Bénélux <http://brasseriebenelux.com/>.
+An unofficial mailing list and other tools to keep faithful bargoers informed of the beers available at the excellent Brasserie Bénélux.
 
 This project is composed of two softwares:
 
index c338656..f1dccff 100644 (file)
@@ -1,4 +1,4 @@
-# SVG to PNG and Nit
+# Tools to extract images from SVG files using Inkscape, either to create icons or game sprites
 
 This tool uses Inkscape to prepare assets for Nit applications from a single SVG file.
 It selects objects to extract from the SVG file when their id begins with `0`.
@@ -25,7 +25,3 @@ It will produce two files:
 The minimal test in `tests/app/` shows the basic usage of this tool.
 
 The Dino example `../../../../examples/mnit_dino` also uses this tool and is a more complete and practical example.
-
-# Authors
-
-Alexis Laferrière <alexis.laf@xymus.net>
index da33dd2..8cc1830 100644 (file)
@@ -1,4 +1,4 @@
-_jwrapper_, an extern class generator from Java class files
+Generator of Nit extern classes to wrap Java APIs.
 
 # Description
 _jwrapper_ automates wrapping Java classes so they can be accessed from Nit code. It generates Nit extern classes by analyzing Java class files.
index 216b878..6723296 100644 (file)
@@ -1,6 +1,4 @@
-# Pep/8 Analysis
-
-This project provides tools to statically analyze Pep/8 programs in order to detect bugs or bad programming practices.
+# Pep/8 Analysis, static checker to detect bugs and bad programming practices in Pep/8 programs
 
 For more information about the Pep/8 assembly language visit http://code.google.com/p/pep8-1/.
 
index 335444a..1c73e64 100644 (file)
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# This programs interprets the input of a physical interface thought the
-# GPIO pins of a Raspberry Pi to control an MPD server.
+# Backend to a hardware interface to control an MPD server from a Raspberry Pi
 #
-# It suppot two inputs: a play/pause button and a rotary encoder to adjust
+# It supports two inputs: a play/pause button and a rotary encoder to adjust
 # the volume.
 #
 # The each data output of the volume control are connected to the board
index eddc63b..b3b85aa 100644 (file)
@@ -1,4 +1,4 @@
-This tool downloads files pointed by RSS feeds.
+A tool to download files listed in RSS feeds according to local folders.
 
 It fetches the content of the RSS feed, then filters it according to custom patterns and to existing folders on disk. Selected elements will be downloaded to the given folder.
 
index 00cb3e1..0a42ca2 100644 (file)
@@ -1,4 +1,4 @@
-# sort_downloads
+Script to sort content of a folder in many folders according to their names.
 
 This scripts sorts files from a given directory to subfolders in the destination directory. It uses directory names as patterns to sort the files and thus moves each file to a directory with a similar name. Multiple directories may be used to specify the patterns to look for, but the files will only be copied to subfolders in the target directory. This features ensures a clean support for a multi-disk system.
 
index 0eca29d..d2893ef 100644 (file)
@@ -1,4 +1,4 @@
-Tnitter is a Twitter-like micro-blogging platform
+Tnitter, a Twitter-like micro-blogging platform
 
 # Compile and execute