index.md

   1 # Package `luamesh`
   2
   3 ## Introduction
   4
   5 <div class="alert alert-warning">
   6 **Attention**, l'extension est en plein développement, nous n'en
   7 sommes à la version 0.5, donc, beaucoup de choses ne sont
   8 pas opérationnelles. Utilisez là, mais en ayant ça en tête.
   9
  10 Tout retour d'utilisation sera le bienvenu !
  11 </div>
  12
  13 <div class="alert alert-warning">
  14 **Warning**, this package is under development, a lot of things is not
  15 working properly yet.
  16
  17 Every feedback will be appreciated.
  18 </div>
  19
  20 ## Documentation
  21
  22 A PDF documentation (in english) is available in the `doc` directory
  23 or with the
  24 following link:
  25
  26 * [luamesh-doc.pdf](doc/luamesh-doc.pdf)
  27
  28 ## Sandbox
  29
  30 You can find files used to test the features in the `test`
  31 directory.
  32
  33 ## Installation
  34
  35 You can download a `zip` file in the `archives` directory or
  36 [here (v0.5)](arcihves/luamesh-v0-5.zip) and follow the instruction written
  37 in the documentation.
  38
  39 ## TODO list
  40
  41 * Translation of the documentation in french.
  42 * For the `meshPolygon` macro, add the option for the grid to be _random_.
  43 * Macro to generate a meshed circle.
  44 * Other 2D algorithms (divide and conquer, etc.)