Skip to content

Write documentation

Ryan Curtin requested to merge rcurtin/bandicoot-code:docs into unstable

I adapted the Armadillo documentation to Bandicoot. It took a little while to go through everything. Bullet points of minor interest:

  • I wanted to do this with Markdown so it was easier to read. But, Markdown does not have support for tables (that is an extension) and it's not possible to exactly imitate the way Armadillo uses tables. Maybe someday I might consider redoing the documentation in Markdown or something else, but honestly HTML was fine, if a little verbose and tedious.

  • I put a copy of the documentation here: http://ratml.org/misc/docs.html

  • I chose a purple color instead of Armadillo's green. That was arbitrary. Are bandicoots purple? I sure have no idea. Let's assume so.

  • The favicon, like Armadillo, is just the first letter of the library as rendered by LaTeX's mathscr font. 😄

  • Added a section on backend configuration

  • Added an Armadillo/Bandicoot conversion guide

  • Added a section on direct linking since it's way more complicated than Armadillo...

  • Added a section on the kernel cache.

  • All functions that Bandicoot doesn't implement have been removed. As they get implemented, they'll be added back in.

The only remaining thing to do is write a technical report and link to it, or something along these lines.

Merge request reports