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 toujours pas à la version 0.1, 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. There is no documentation (but there will be).
  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 ## Installation
  29
  30 You can download a `zip` file in the `archives` directory or
  31 [here](arcihves/luamesh-v0-1.zip) and follow the instruction written
  32 in the documentation.
  33
  34 ## TODO list
  35
  36 * Voronoi diagram
  37 * Reader for gmesh `msh` file to plot meshes produced by this
  38   software.
  39 * Macro to generate a meshed rectangle.
  40 * Macro to generate a meshed circle.
  41 * Macro that, given a border defined by a set of points, adds points
  42   inside to generate the mesh.
  43 * Other 2D algorithms (divide and conquer, etc.)