X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcpPlugins%2FOS%2Ftinydir_README.md.txt;fp=lib%2FcpPlugins%2FOS%2Ftinydir_README.md.txt;h=0000000000000000000000000000000000000000;hb=2e142df11d6f312a2a2b5097b8da73571ed523e8;hp=3fab002c01eea63af719d72bc74e4daee5093c53;hpb=61b3659afe961ed248f30e26f9ca8f28fcfafddc;p=cpPlugins.git diff --git a/lib/cpPlugins/OS/tinydir_README.md.txt b/lib/cpPlugins/OS/tinydir_README.md.txt deleted file mode 100644 index 3fab002..0000000 --- a/lib/cpPlugins/OS/tinydir_README.md.txt +++ /dev/null @@ -1,78 +0,0 @@ -TinyDir -======= -[![Build Status](https://travis-ci.org/cxong/tinydir.svg?branch=master)](https://travis-ci.org/cxong/tinydir)[![Project Stats](https://www.openhub.net/p/tinydir/widgets/project_thin_badge.gif)](https://www.openhub.net/p/tinydir) - -Lightweight, portable and easy to integrate C directory and file reader. TinyDir wraps dirent for POSIX and FindFirstFile for Windows. - -Windows unicode is supported by defining `UNICODE` and `_UNICODE` before including `tinydir.h`. - -Example -======= - -There are two methods. Error checking omitted: - -```C -tinydir_dir dir; -tinydir_open(&dir, "/path/to/dir"); - -while (dir.has_next) -{ - tinydir_file file; - tinydir_readfile(&dir, &file); - - printf("%s", file.name); - if (file.is_dir) - { - printf("/"); - } - printf("\n"); - - tinydir_next(&dir); -} - -tinydir_close(&dir); -``` - -```C -tinydir_dir dir; -int i; -tinydir_open_sorted(&dir, "/path/to/dir"); - -for (i = 0; i < dir.n_files; i++) -{ - tinydir_file file; - tinydir_readfile_n(&dir, &file, i); - - printf("%s", file.name); - if (file.is_dir) - { - printf("/"); - } - printf("\n"); -} - -tinydir_close(&dir); -``` - -See the `/samples` folder for more examples, including an interactive command-line directory navigator. - -Language -======== - -ANSI C, or C90. - -Platforms -========= - -POSIX and Windows supported. Open to the possibility of supporting other platforms. - -License -======= - -Simplified BSD; if you use tinydir you can comply by including `tinydir.h` or `COPYING` somewhere in your package. - -Known Limitations -================= - -- Limited path and filename sizes -- [Possible race condition bug if folder being read has changing content](https://github.com/cxong/tinydir/issues/13)