New readmes by Morriar · Pull Request #366 · Morriar/nit

Morriar · 2018-08-23T01:57:57Z

No description provided.

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

privat

relu a* et b*

privat · 2018-08-23T15:49:43Z

lib/a_star/README.md

+* [Running the tests](#Running-the-tests)
+* [Authors](#Authors)
+
+A single graph may have different properties according to the `PathContext` used


pourquoi cette phrase ici

privat · 2018-08-23T15:53:18Z

lib/actors/README.docdown.md

+
+## Features
+
+[[features: actors | mentities: actors::Actor;actors::Mailbox;actors::Message;actors::Proxy;actors::ShutDownMessage;actors::Future;actors::SynchronizedCounter;actors::ActorClockAgent;actors::ActorAgent;actors::MessageClockAgent;actors::ClockAgentMessagenb_steps;actors::ClockAgentMessageagents;actors::ClockAgentMessagenb_finished;actors::ClockAgentMessagedo_step;actors::ClockAgentMessagefinished_step;actors::MessageAgent;actors::AgentMessagedo_step;actors::AgentMessageend_step;actors::AgentMessageothers;actors::AgentMessagecount;actors::AgentMessagegreet;actors::AgentMessagegreet_back;actors::ProxyClockAgent;actors::ProxyAgent;actors::ActorCreature;actors::MessageCreature;actors::CreatureMessageplace;actors::CreatureMessagecolor;actors::CreatureMessageid;actors::CreatureMessagecount;actors::CreatureMessagesamecount;actors::CreatureMessagerun;actors::CreatureMessageto_string;actors::ProxyCreature;actors::ActorFannkuchRedux;actors::MessageFannkuchRedux;actors::FannkuchReduxMessagep;actors::FannkuchReduxMessagepp;actors::FannkuchReduxMessagecount;actors::FannkuchReduxMessageprint_p;actors::FannkuchReduxMessagefirst_permutation;actors::FannkuchReduxMessagenext_permutation;actors::FannkuchReduxMessagecount_flips;actors::FannkuchReduxMessagerun_task;actors::FannkuchReduxMessagerun;actors::ProxyFannkuchRedux;actors::ActorWorker;actors::MessageWorker;actors::WorkerMessageget_byte;actors::WorkerMessageput_line;actors::WorkerMessagework;actors::ProxyWorker;actors::ActorA;actors::MessageA;actors::AMessagefoo;actors::AMessagebar;actors::ProxyA;actors::ActorThreadRing;actors::MessageThreadRing;actors::ThreadRingMessageid;actors::ThreadRingMessagenext;actors::ThreadRingMessagesend_token;actors::ProxyThreadRing]]


est-ce vraiment maintenable une telle liste?

privat · 2018-08-23T15:54:43Z

lib/actors/README.md

+
+## Features
+
+* `AMessagebar`


La liste est pas utile

privat · 2018-08-23T15:57:14Z

lib/android/README.md

+* [Features](#Features)
+* [Authors](#Authors)
+
+This module provides basic logging facilities, advanced logging can be


mauvais texte. ca devrait pas commencer par ca

privat · 2018-08-23T16:00:47Z

lib/android/README.md

+
+### Dependencies
+
+This project requires the following packages:


toutes les dépendances sont pas 'required' vu que android fournit des implem pour des api abstraites optionelles

privat · 2018-08-23T16:38:43Z

lib/bcm2835/README.md

+
+## Features
+
+* `Buzzer`


ca manque de description longue

privat · 2018-08-23T16:39:26Z

lib/binary/README.md

@@ -0,0 +1,34 @@
+# `binary` - Read and write binary data with any `Reader` and `Writer`
+
+~~~


ca manque de texte

privat · 2018-08-23T16:39:48Z

lib/binary/README.md

+
+## Features
+
+* `BinaryStream` - A stream of binary data


une liste de 1 sert un peu a rien

privat · 2018-08-23T16:40:47Z

lib/bitmap/README.md

+For information on the bitmap format, see
+http://en.wikipedia.org/wiki/BMP_file_format
+
+A module containing classes for manipulating bitmap images


Ligne seule bizarre

privat · 2018-08-23T16:41:00Z

lib/bitmap/README.md

+* [Running the tests](#Running-the-tests)
+* [Authors](#Authors)
+
+~~~nitish


Ca manque de texte

privat

jusqu'à java

privat · 2018-08-23T17:31:56Z

lib/cartesian/README.md

+Collection[Int] X Collection[String] -> Collection[(Int,String)]
+
+However, in Nit, there in no native *tuple* type.
+So we need a first building block, a pair.


The last sentence is weird

privat · 2018-08-23T17:33:12Z

lib/cartesian/README.md

+
+Properties:
+
+* `Cartesian::swap` - Returns a new Cartesian where the first collection is the second.


Une liste d'un élément est louche.
swap n'est pas si intéressant à mettre dans le readme

privat · 2018-08-23T17:34:13Z

lib/cocoa/README.md

+This wrapper of the Cocoa API regroups the Foundation Kit and the
+Application Kit.
+
+Example from `cocoa::cocoa_extern_types`:


mineur: exemple trop avancé

privat · 2018-08-23T17:38:37Z

lib/config/README.md

+
+Properties:
+
+* `IniConfig::config_file` - Return the config file path from options or the default


mineur: pas interessant

privat · 2018-08-23T17:44:54Z

lib/console/README.md

+
+## Features
+
+### `TermClearDisplay` - ANSI/VT100 code to clear the entire display and move the cursor to the top left of screen (ED 2).


mineur: enlever cette classe (ou mettre à la fin)

privat · 2018-08-23T19:45:56Z

lib/html/README.md

+
+See http://getbootstrap.com/components/
+
+Example from `html::html_page`:


l'exemple utilise pas bootstrap. a remonter

privat · 2018-08-23T19:46:44Z

lib/html/README.md

+page.write_to stdout
+page.write_to_file("nit.html")
+~~~
+


on voudrait les classes

privat · 2018-08-23T19:47:43Z

lib/ini/README.md

+
+## Features
+
+### `ConfigTree` - A configuration tree that can read and store data in ini format


trop de configtree

privat · 2018-08-23T19:48:38Z

lib/ios/README.docdown.md

+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine.


c'est pas un programme

privat · 2018-08-23T19:53:13Z

lib/json/README.md

+
+### `dynamic` - Dynamic interface to read values from JSON strings
+
+Most services are in `JsonValue`, which is created by `Text::to_json_value`.


mettre la doc de JsonValue

Morriar added 2 commits August 22, 2018 21:48

CLEAN READMES

a79b13f

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

GENERATE READMES

49af7d5

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

privat reviewed Aug 23, 2018

View reviewed changes


		## Features

		[[features: actors \| mentities: actors::Actor;actors::Mailbox;actors::Message;actors::Proxy;actors::ShutDownMessage;actors::Future;actors::SynchronizedCounter;actors::ActorClockAgent;actors::ActorAgent;actors::MessageClockAgent;actors::ClockAgentMessagenb_steps;actors::ClockAgentMessageagents;actors::ClockAgentMessagenb_finished;actors::ClockAgentMessagedo_step;actors::ClockAgentMessagefinished_step;actors::MessageAgent;actors::AgentMessagedo_step;actors::AgentMessageend_step;actors::AgentMessageothers;actors::AgentMessagecount;actors::AgentMessagegreet;actors::AgentMessagegreet_back;actors::ProxyClockAgent;actors::ProxyAgent;actors::ActorCreature;actors::MessageCreature;actors::CreatureMessageplace;actors::CreatureMessagecolor;actors::CreatureMessageid;actors::CreatureMessagecount;actors::CreatureMessagesamecount;actors::CreatureMessagerun;actors::CreatureMessageto_string;actors::ProxyCreature;actors::ActorFannkuchRedux;actors::MessageFannkuchRedux;actors::FannkuchReduxMessagep;actors::FannkuchReduxMessagepp;actors::FannkuchReduxMessagecount;actors::FannkuchReduxMessageprint_p;actors::FannkuchReduxMessagefirst_permutation;actors::FannkuchReduxMessagenext_permutation;actors::FannkuchReduxMessagecount_flips;actors::FannkuchReduxMessagerun_task;actors::FannkuchReduxMessagerun;actors::ProxyFannkuchRedux;actors::ActorWorker;actors::MessageWorker;actors::WorkerMessageget_byte;actors::WorkerMessageput_line;actors::WorkerMessagework;actors::ProxyWorker;actors::ActorA;actors::MessageA;actors::AMessagefoo;actors::AMessagebar;actors::ProxyA;actors::ActorThreadRing;actors::MessageThreadRing;actors::ThreadRingMessageid;actors::ThreadRingMessagenext;actors::ThreadRingMessagesend_token;actors::ProxyThreadRing]]


		### Dependencies

		This project requires the following packages:

		@@ -0,0 +1,34 @@
		# `binary` - Read and write binary data with any `Reader` and `Writer`

		~~~


		Properties:

		* `Cartesian::swap` - Returns a new Cartesian where the first collection is the second.


		Properties:

		* `IniConfig::config_file` - Return the config file path from options or the default


		## Features

		### `TermClearDisplay` - ANSI/VT100 code to clear the entire display and move the cursor to the top left of screen (ED 2).


		See http://getbootstrap.com/components/

		Example from `html::html_page`:


		## Features

		### `ConfigTree` - A configuration tree that can read and store data in ini format


		## Getting Started

		These instructions will get you a copy of the project up and running on your local machine.


		### `dynamic` - Dynamic interface to read values from JSON strings

		Most services are in `JsonValue`, which is created by `Text::to_json_value`.

Conversation

Morriar commented Aug 23, 2018

Uh oh!

privat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

privat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants