Docs

[davidomarf]

Edit: Accidentaly requested PR without filling message. All the content in this message is posted in the edit.

• Create a README.md file containing what is and will be libdaque.

  • May require more specificity on:
    • What it currently is.
    • What we want it to be in a 1.0.0 release
    • What it's not, and won't be.

• Copy (and modify when appropiate) all community files from daque-dev/viare.

  • Issue and PR templates.
  • Contributing file.
  • Code of conduct.

• Create a Changelog to be filled with next modifications on source code.

---

Discussion ideas:

• Contributions (whether additions, deletions, or corrections) to README.

[quevangel]

Ok.

[quevangel]

I think the README is way too ambitious.

[quevangel]

There is no mesh generation in libdaque at the time being. Currently the mesh is generated in ViaRE.

[davidomarf]

There is no mesh generation in libdaque at the time being. Currently the mesh is generated in ViaRE.

Fixed.

[quevangel]

Shouldn't it say "mathematical operations" instead of "mathematic operations"?
Also, I am not sure there is already code in libdaque that deals with 3D visualization.
Maybe only 3D manipulation, as in rotations, but still no "visualization".

[quevangel]

We should not mention all of the "ideal" features in the README, as I said earlier many of them seem to be way too ambitious and I do not like to lie.

The README must also make clear that libdaque evolves very accordingly to the necessities of ViaRE and that by itself it does not have a very well defined objective or purpose, aside from serving ViaRE.

[davidomarf]

We need to specify the API.

Should we do it in README or a wiki?

[quevangel]

A wiki would be a more fitting solution.
How will we specify it? By showing the public symbols and their use?

[quevangel]

We could use the ddox generator to make it look like the D's standard library documentation.

[quevangel]

And host it in our website.

[davidomarf]

Agreed.