Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 1.95 KB

README.md

File metadata and controls

64 lines (44 loc) · 1.95 KB
Raw

Meaningful title for the repository

pick type of repository (TOOL, ETL, ANALYSIS, ADMIN)

Purpose

[In two to three sentences state the purpose of this repository, ideally tying it to an existing SDAM milestone. E.g., The purpose of this repository is to provide templates for all future SDAM repositories in order to save precious time and maintain high standards and uniformity of our documentation.]

Authors

  • Petra Hermankova , SDAM project, petra@ancientsocialcomplexity.org
  • [Name], [ORCID], [Institution], [email]
  • [Name], [ORCID], [Institution], [email]
  • [Name], [ORCID], [Institution], [email]

License

CC-BY-SA 4.0, see attached License.md

DOI

[Here will be DOI or some other identifier once we have it]

References

[Here will go related articles or other sources we will publish/create]

How to use this repository

Sources and prerequisites

[Describe the provenance of data used in the scripts contained and clarify how it is harvested and what other prerequisites are required to get the scripts working. In case of pure tool attribute any reused scripts to source, etc., license and specify any prerequisites or technical requirements.]

Data

Anything else on data metadata and data used. Link to data repository or explanatory article.

Software

  1. Software X, minimum version 123
  2. Software Y, version 456

Registered account

  1. CompanyA
  2. CompanyB

Hardware

  1. Multiple-screen
  2. Mouse
  3. Coffee

Installation

[Describe the steps necessary to install the tool/package; example: https://gist.github.com/PurpleBooth/109311bb0361f32d87a2]

Instructions

[Describe first steps, how to use the current repository by a typical user - the digital historian with limited technical skills]

  1. First, do ...
  2. Second, do ...
  3. Third, go to ...

Screenshots

Example screenshot