From f52d07f806030e2aa2a9f4c822808e0e06cfb1ff Mon Sep 17 00:00:00 2001 From: Alexander Ororbia Date: Mon, 8 Apr 2024 20:01:27 -0400 Subject: [PATCH] update to sub-dir readme's --- exhibitors/README.md | 12 +++++++++--- exhibits/README.md | 9 +++++---- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/exhibitors/README.md b/exhibitors/README.md index c674429..8efe523 100755 --- a/exhibitors/README.md +++ b/exhibitors/README.md @@ -12,11 +12,17 @@ The contents of each exhibitor sub-directory may be organized and structured however the exhibitor requires, though it is recommended that each sub-directory within an exhibitor's folder pertains to a single paper/publication or application. The only file we require in an exhibitor's folder is a single -markdown file -- `README.md` -- containing information about the exhibitor and a -header containing the name of the exhibitor, e.g., the researcher, organization, -company, or research group/lab, as follows: +markdown file -- `README.md` at the top-level -- containing information +about the exhibitor and a header containing the name of the exhibitor, +e.g., the researcher, organization, company, or research group/lab, +as follows: ```markdown # ...rest of text... ``` + +It is up to the exhibitor to provide the relevant context and explanation of +how a set of models relate to one another (if they do), a research group's body of +ongoing work, or the broader goals they are meant to satisfy, hypotheses they +are meant to test, and general research questions they seek to answer. diff --git a/exhibits/README.md b/exhibits/README.md index a29c785..7e10d66 100755 --- a/exhibits/README.md +++ b/exhibits/README.md @@ -4,10 +4,11 @@ In this directory, each directory should contain a single scientific or engineered model/project using ngc-learn. The content and organization within -this directory is dependent on the project/model/agent and generally will -contain application/task-specific structuring code, e.g., agent classes with -specified functions pertinent to the problem/task examined in a paper's -experiment. The only file we specifically require in an exhibition's folder is a single