Library name

This page shows a basic minimalist template for creating pages on this wiki explaining library or packages, either taken from external sources or developed in the team. Some parts may be added by authors at their discretion, if they think them necessary.

For ROS packages: An adapted template is preferable, see template-ros-package.

Now for the content of each required section.

Before any section, you should mention which version of the package you're referring to (e.g. 6.4.0), and for which language it was written and/or can be used.

In this section, you get to explain what the library does, how it works (algorithms, techniques it is based on). Be creative. If you think you need to explain a more theoretical concept, or the algorithm used in more details, you are strongly encouraged to create a specific page for that. You can then integrate it using either an internal link (lazy) or also integrating parts of the page, like a quick overview of the algorithm (preferable) as it is shown in the general best practices page.

Explain here what are the requirements of the package, does it need other packages (specific versions) to be installed, a specific platform, operating system, programing language or interface?

Explain here step by step how to install this package. If possible, detail where to find it. If it is a package developed internally, please add a link to a repository, or even add an archive with the code on the wiki. If there is a quick test that enable to test if the installation was successful, add it here.

Here you can explain how to integrate this package into our projects, as well as give some tutorials or tips about the package, demos, etc. If you can, create a dedicated other page with a tutorial, to explain how to use the package. Multiple tutorials for one package, showing different uses are possible and even encouraged when a package is particularly versatile.

Please develop here how you have used this package, for what project, if other packages were combined. If the explanation of the projects becomes quite long, then they probably deserve a page of their own, which you can create using the template template-project. Then integrate them using internal links (minimal) and in conjunction with the most relevant section from this project page for illustrating the use of the package to any potential user (e.g. overview of the project or section indicating how you use this package for this project).

If you want to, you can here give a detailed documentation of the API developed in the package. It is especially encouraged for internally developed packages.

You can here detail the bugs you encountered, and every hacks/tips you have practiced regarding the use of this package.

Give external links and describe them (e.g. Documentation, Source code, etc.)

  • template-software.txt
  • Last modified: 2019/04/25 14:08
  • (external edit)