From 5e04f6cbb4e2759b389849bf356899884ac7cee3 Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 11 Apr 2003 13:36:16 -0400 Subject: [PATCH] ENH: Added documentation for ITK. --- Source/kwsys/README.itk | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 Source/kwsys/README.itk diff --git a/Source/kwsys/README.itk b/Source/kwsys/README.itk new file mode 100644 index 000000000..30206d4ab --- /dev/null +++ b/Source/kwsys/README.itk @@ -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 + +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.