Edit readmes #367
Edit readmes #367
Conversation
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
| This group introduces the [`actors`](actors::actors) module which contains the abstraction of a Nit Actor Model, | ||
| based on Celluloid (https://github.com/celluloid/celluloid). | ||
|
|
||
| Example from `actors::chameneosredux`: |
There was a problem hiding this comment.
C'est pas le meilleur exemple, le code est assez compliqué
| For now, there isn't any mecanism to recreate and actor after it was terminated. | ||
| Sending messages after terminating it results in unspecified behaviour. | ||
|
|
||
| Example from `actors::simple`: |
| You can use this property as a mean of synchronisation in some specific cases (for example if you're | ||
| using actors for fork/join parallelism instead of concurrency). | ||
|
|
||
| Example from `actors::fannkuchredux`: |
|
|
||
| You can find example of differents small programs implemented with Nit actors in the `examples` | ||
| directory. For a really simple example, you can check `examples/simple`. | ||
|
|
There was a problem hiding this comment.
vu le contexte, il aurait fallu inclure examples/simple ici :)
|
|
||
| * see `search` | ||
|
|
||
| * `ai` - Simple toolkit for artificial intelligence. |
There was a problem hiding this comment.
ai n'est pas très intéressant ici.
Il faudrait enlever les deux see existant
| # Compilation modes | ||
| #### `assets_and_resources` | ||
|
|
||
| > Use the ResourceManager to retrieve resources from the `res` folder of your app |
|
|
||
| ## `notification` | ||
|
|
||
| > ~~~~nitish |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| By default, `nitc` will compile Android applications in debug mode. | ||
|
|
||
| ## Release mode | ||
| Example from `android::ui_test`: |
|
|
||
| ## `android` | ||
|
|
||
| > This module provides basic logging facilities, advanced logging can be |
There was a problem hiding this comment.
C'est vraiment tout ce que android fait?
| required passwords as needed by `jarsigner`. | ||
| required passwords as needed by `jarsigner`. | ||
|
|
||
| ## `android` |
There was a problem hiding this comment.
vu qu'ici ca cause des modules individuels, il manque une séparations ou une transition avec le reste du document
privat
left a comment
privat
left a comment
There was a problem hiding this comment.
jusqu'à markdown (mais j'ai sauté des trucs)
| * Compilation and packaging | ||
|
|
||
| The features offered by _app.nit_ are common to all platforms, but | ||
| The features offered by _[[app]].nit_ are common to all platforms, but |
| may not be available on all devices. | ||
|
|
||
| # Application Life-Cycle | ||
| ## Getting Started |
| So all UI elements can react separately to live-cycle events. | ||
|
|
||
| # User Interface | ||
| ## `ui` |
| the interesting module is in this repository at ../../examples/calculator/src/android_calculator.nit | ||
|
|
||
| # Persistent State with data\_store | ||
| ## `data_store` |
| # Persistent State with data\_store | ||
| ## `data_store` | ||
|
|
||
| > The main services is `App::data_store`, a `DataStore` holding any |
There was a problem hiding this comment.
mieux dit dessous (p'tet remonter le bout du readme dans le module?)
| Usage: | ||
|
|
||
| var proc = new MarkdownProcessor |
| Or you can use it programmatically by importing the `markdown` module. | ||
| Or you can use it programmatically by importing the [`markdown`](markdown::markdown) module. | ||
|
|
||
| * `decorators` - Decorators for `markdown` parsing. |
| SEE: `String::md_to_html` for a shortcut. | ||
|
|
||
| The NitUnit test suite can be found in `test_markdown.nit`. | ||
| ## `wikilinks` |
|
|
||
| Minimalists tests are prefixed with `test_process_*`. All tests from daringfireball are prefixed with `test_daring*`. | ||
|
|
||
| Run the test suite: |
|
|
||
| ~~~bash | ||
| $ nitunit lib/markdown/markdown.nit -t lib/markdown/test_markdown.nit | ||
| nitunit . |
There was a problem hiding this comment.
est-ce que la nouvelle commande est vraiment mieux ?
|
|
||
| ~~~ | ||
| import json | ||
There was a problem hiding this comment.
pourquoi ca a ajouté l'import? ça semble inutile
| errors to the console. It is fit only for small scripts and other quick and dirty usage. | ||
|
|
||
| ### Example | ||
| * `dynamic` - Dynamic interface to read values from JSON strings |
| and the FFI enables calling services in different languages. | ||
|
|
||
| # Examples | ||
| Example from `nitcorn::nitcorn_reverse_proxy`: |
There was a problem hiding this comment.
c'est pas le meilleur exemple et ya une section example existante juste en dessous de toute facon
| Dynamic content is served by subclassing `Action` and implementing `answer`. | ||
| This method receives an `HttpRequest` and must return an `HttpResponse`. | ||
| _nitcorn_ provides `FileServer`, a simple `Action` to serve static files. | ||
| > The main classes are: |
There was a problem hiding this comment.
le texte existant dit ça mieux il me semble
| * _tnitter_ is a micro-blogging platform with a simple Web and RESTful interface. | ||
| * _benitlux_ uses a custom `Action` to subscribe people to a mailing list and define a RESTful interface. | ||
| * _benitlux_ uses a custom `Action` to subscribe people to a mailing list and define a RESTful [interface](nitcorn::Interfaces). | ||
| Example from `nitcorn::nitcorn_hello_world`: |
| * `VirtualHost` to listen on a specific interface and behave accordingly | ||
| * `HttpFactory` which is the base dispatcher class. | ||
|
|
||
| Basic usage example: |
There was a problem hiding this comment.
un exemple minimal est deja dans le README. mais le remonter ici est une bonne suggestion.
| > with the response if a session has been associated to the response object. | ||
| ## `log` | ||
|
|
|
|
||
| Thanks to the contribution of: | ||
|
|
||
| * **Jean-Philippe Caissy <mailto:jean-philippe.caissy@shopify.com>** |
There was a problem hiding this comment.
redondant avec ce qu'on avait avant. La liste des contributeurs historique
| * **Stephan Michaud** | ||
| * **Maxime Bélanger** | ||
|
|
||
| Example from `nitcorn::htcpcp_server`: |
| ~~~nit | ||
| import nlp | ||
| var proc = new NLPJavaProcessor("path/to/StanfordCoreNLP/jars") |
There was a problem hiding this comment.
NLPProcessor a été changé en NLPJavaProcessor. est-ce légitime ?
| See `https://stanfordnlp.github.io/CoreNLP/corenlp-server.html`. | ||
|
|
||
| ~~~nitish | ||
| ~~~nit |
There was a problem hiding this comment.
enlever le nitish va pauser des problèmes de nitunit
lib/nlp/README.docdown.md
Outdated
| ~~~nit | ||
| import nlp | ||
| ~~~nitish |
| assert index.documents.length == 2 | ||
| matches = index.match_string("this sample") | ||
| var matches = index.match_string("this sample") |
| This wrapper needs the Stanford CoreNLP jars that run on Java 1.8+. | ||
|
|
||
| See http://nlp.stanford.edu/software/corenlp.shtml. | ||
| > See http://nlp.stanford.edu/software/corenlp.shtml. |
|
|
||
| ## `redef_collections` | ||
|
|
||
| > This modules is intended to be used with scripts or quick prototypes. |
| are added to the underlying collections by refinement or evolution, they | ||
| might need to be covered in the concurrent version. | ||
|
|
||
| ## `BlockingQueue` |
There was a problem hiding this comment.
vide. a enlever (ou documenter la classe)
| `sdl2::image` at this point. | ||
|
|
||
| # Examples | ||
| Example from `sdl2::minimal`: |
There was a problem hiding this comment.
exemple trop long. un lien vers le fichier est suffisant (comme précédemment mis en oeuvre)
| ~~~ | ||
|
|
||
|
|
||
| * `all` - Unites the main `sdl2` module and its sister library `sdl2::image` |
|
|
||
| [[features: sdl2 | mentities: sdl2::all;sdl2::sdl2;sdl2::syswm;sdl2::image;sdl2::mixer;sdl2::events;sdl2::sdl2_base]] | ||
|
|
||
| ## [[sign: sdl2::image]] |
There was a problem hiding this comment.
les 5 sections ajoutés (parmi trop) ne semblent pas assez pertinente.
| classes or any other subclass of [[serialization::Serializable | text: `Serializable`]]. | ||
|
|
||
| ~~~ | ||
| import serialization |
There was a problem hiding this comment.
non. l'exemple est coupé en morceaux avec le texte autour
|
|
||
| ~~~ | ||
| module shared_between_clients is serialize | ||
| import serialization |
There was a problem hiding this comment.
non. l'exemple est coupé en morceaux avec le texte autour
| Only the attributes with the `serialize` annotation will be serialized. | ||
|
|
||
| ~~~ | ||
| import serialization |
There was a problem hiding this comment.
non. l'exemple est coupé en morceaux avec le texte autour
| end | ||
| ~~~ | ||
|
|
||
| Example from `serialization::custom_serialization`: |
There was a problem hiding this comment.
pas besoin ici. plus tard si ce n'est deja fait
| if name == "User" then | ||
| # Deserialize normally | ||
| var user = deserialize_attribute("name") | ||
| var user = deserialize_attribute("name").as(String) |
| ~~~ | ||
| import json | ||
| ~~~nitish | ||
| mport json |
| ~~~ | ||
|
|
||
| ## FileIndex | ||
| Example from `vsm::example_vsm`: |
There was a problem hiding this comment.
ok mais mettre l'exemple a a fin de la section. l'exemple est gros. p'tet juste un lien
| It is based on the portability framework _app.nit_ and the OpenGL ES 2.0 standard. | ||
|
|
||
| # System configuration | ||
| ## Getting Started |
| `App::frame_core` to update the screen and `App::accept_event` to receive user inputs. | ||
|
|
||
| * `flat` provides an easy to use API for 2D games based on sprites. | ||
| * [[gamnit>flat> | text: `flat`]] provides an easy to use API for 2D games based on sprites. |
There was a problem hiding this comment.
pourquoi gamnit>flat> et pas le module flat?
|
|
||
| * [[gamnit>network> | text: `network`]] provides a simple communication framework for multiplayer client/server games. | ||
|
|
||
| [[features: gamnit | mentities: gamnit::landscape;gamnit::portrait;gamnit::common;gamnit::camera_control;gamnit::network;gamnit::vr;gamnit::android19;gamnit::gamnit_ios;gamnit::display;gamnit::flat;gamnit::keys;gamnit::depth_core;gamnit::limit_fps;gamnit::camera_control_linux;gamnit::input_ios;gamnit::display_ios;gamnit::gamnit;gamnit::display_android;gamnit::font;gamnit::cardboard;gamnit::stereoscopic_view;gamnit::texture_atlas_parser;gamnit::client;gamnit::cameras_cache;gamnit::depth;gamnit::mtl;gamnit::gamnit_linux;gamnit::camera_control_android;gamnit::display_linux;gamnit::server;gamnit::particles;gamnit::tileset;gamnit::virtual_gamepad_spritesheet;gamnit::obj;gamnit::more_lights;gamnit::gamnit_android;gamnit::model_parser_base;gamnit::model_dimensions;gamnit::textures;gamnit::egl;gamnit::selection;gamnit::more_meshes;gamnit::dynamic_resolution;gamnit::virtual_gamepad;gamnit::programs;gamnit::cameras;gamnit::bmfont;gamnit::shadow;gamnit::more_models;gamnit::more_materials;gamnit::flat_core]] |
|
|
||
| [[features: gamnit | mentities: gamnit::landscape;gamnit::portrait;gamnit::common;gamnit::camera_control;gamnit::network;gamnit::vr;gamnit::android19;gamnit::gamnit_ios;gamnit::display;gamnit::flat;gamnit::keys;gamnit::depth_core;gamnit::limit_fps;gamnit::camera_control_linux;gamnit::input_ios;gamnit::display_ios;gamnit::gamnit;gamnit::display_android;gamnit::font;gamnit::cardboard;gamnit::stereoscopic_view;gamnit::texture_atlas_parser;gamnit::client;gamnit::cameras_cache;gamnit::depth;gamnit::mtl;gamnit::gamnit_linux;gamnit::camera_control_android;gamnit::display_linux;gamnit::server;gamnit::particles;gamnit::tileset;gamnit::virtual_gamepad_spritesheet;gamnit::obj;gamnit::more_lights;gamnit::gamnit_android;gamnit::model_parser_base;gamnit::model_dimensions;gamnit::textures;gamnit::egl;gamnit::selection;gamnit::more_meshes;gamnit::dynamic_resolution;gamnit::virtual_gamepad;gamnit::programs;gamnit::cameras;gamnit::bmfont;gamnit::shadow;gamnit::more_models;gamnit::more_materials;gamnit::flat_core]] | ||
|
|
||
| ## [[sign: gamnit::network]] |
There was a problem hiding this comment.
les ajouts sont pertinants, il faudrait par contre nettoyer le texte existant dans le README et enlever des ajouts pas tres interessant comme android19 (ou les mettre à la fin)
No description provided.