Creating a README File for Datasets

Help readers understand your submitted dataset with a README file.

Make your submitted data easier to understand with a detailed README file. Include the following sections in your README file:

  • Description: An overall description of the objects and what the audience can expect to gain by downloading them;
  • Size: The total size of all objects, in kilobytes if less than one megabyte in size, or in megabytes if one megabyte or greater in size. This will allow IEEE to provide IEEE Xplore® Digital Library users with information that will help them to make downloading decisions;
  • Platform: The platform required to use these files;
  • Environment: The environment needed (operating system, version, particular libraries, compiler versions, DLLs, etc.);
  • Major component description: A detailed description of the major components of the data set;
  • Detailed setup instructions: These instructions should be set up in a step-by-step format, including information on how to perform any necessary set-up. For example: creating directories, copying/moving files into particular locations, etc.;
  • Detailed run instructions: A set of detailed instructions on how to compile or run any program(s) associated with the data set or collection, any special set-up of the computer environment required, etc.;
  • Output description: A description of the expected output of the program(s) so users will know if they are seeing what the author intended;
  • Contact information: The author should provide contact information in case users have questions regarding the multimedia material.

Format your README file in PDF or text format for easy accessibility. If your article is accepted, all supplemental files including the README file will be compressed into a .zip file or .tar.gz file as appropriate. The compressed file will be uploaded to IEEE Xplore with the rest of the article.