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:59] nduminy [Overview] |
template-software [2019/04/25 14:08] (current) |
||
|---|---|---|---|
| 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) ===== | ||
| 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.) | ||