Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
template-software [2019/04/25 11:10] nduminy |
template-software [2019/04/25 14:08] (current) |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| In this section, you get to explain what the library does, how it works (algorithms, techniques it is based on). | 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, following the template available [[template-theory|here]]. 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. | + | 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. |
| ===== Requirements ===== | ===== Requirements ===== | ||
| Line 26: | Line 26: | ||
| ===== How to use ===== | ===== How to use ===== | ||
| - | 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. | + | 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. |
| ===== Tested use (facultative but encouraged) ===== | ===== Tested use (facultative but encouraged) ===== | ||
| Please develop here how you have used this package, for what project, if other packages were combined. | Please develop here how you have used this package, for what project, if other packages were combined. | ||
| - | If you 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 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). |
| ===== API (facultative) ===== | ===== API (facultative) ===== | ||
| Line 37: | Line 37: | ||
| If you want to, you can here give a detailed documentation of the API developed in the package. | 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. | It is especially encouraged for internally developed packages. | ||
| + | |||
| + | ===== Bugs known and tips ===== | ||
| + | |||
| + | You can here detail the bugs you encountered, and every hacks/tips you have practiced regarding the use of this package. | ||
| ===== External links ===== | ===== External links ===== | ||
| Give external links and describe them (e.g. Documentation, Source code, etc.) | Give external links and describe them (e.g. Documentation, Source code, etc.) | ||