ENH: Added documentation for ITK.

This commit is contained in:
Brad King 2003-04-11 13:36:16 -04:00
parent a4f49798c4
commit 5e04f6cbb4
1 changed files with 24 additions and 0 deletions

24
Source/kwsys/README.itk Normal file
View File

@ -0,0 +1,24 @@
KWSys provides a platform-independent API to many common system
features that are implemented differently on every platform. This
library is intended to be shared among many projects.
How to use KWSys from ITK:
#include <itkkwsys/SystemTools.hxx>
bool MyIsDirectory(const char* fname)
{
return itkkwsys::SystemTools::FileIsDirectory(fname);
}
How to modify KWSys:
When adding a method to an existing class, make no mention of ITK.
KWSys has no knowledge of ITK headers or libraries. Please also keep
in mind that KWSys must be able to build on more platforms and
compilers than ITK. Refer to existing code for conventions to ease
this task.
If you want to add a class, please contact the ITK mailing list for
discussion. Please do not add a class without permission from
Kitware.