Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README to full media export #788

Open
noah-schechter opened this issue Dec 1, 2023 · 0 comments
Open

Add README to full media export #788

noah-schechter opened this issue Dec 1, 2023 · 0 comments

Comments

@noah-schechter
Copy link
Collaborator

noah-schechter commented Dec 1, 2023

The README.txt should contain the following copy:

This folder contains a comprehensive copy of the project "[INSERT PROJECT]" and contains several different types of files and folders. This folder is organized as follows:

  • project.json includes general information about the project, including its name, description, and code; its attributes, their descriptions, types, and values; and whether or not the project is archived.
  • Each folder contains a single incident's data, which contains a metadata.json file, an updates.json file, and folders for each piece of source material.
  • The incident-level metadata.json file contains information about the incident's source material, including each file's hashes.
  • The incident-level updates.json file is a log of each update made to an incident, including who changed what data at what time.
  • Each piece of source material has a folder which contains visual media and a metadata.json file.
  • The source material-level metadata.json file contains information about the source material, including its hashes and source URL.

(Ideally we'd include an ASCII directory tree because this file structure is difficult to communicate without some visual hierarchy, but because it's also a good idea to use plain text, I think this is the best we can do.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant