From bfcef089ba4ff264bba71712f9b31eb921af1139 Mon Sep 17 00:00:00 2001 From: Oliver Bonham-Carter Date: Mon, 1 Apr 2024 00:41:07 -0400 Subject: [PATCH] Update README --- data/README.md | 6 ------ src/README.md | 2 +- 2 files changed, 1 insertion(+), 7 deletions(-) delete mode 100644 data/README.md diff --git a/data/README.md b/data/README.md deleted file mode 100644 index eb3d82d..0000000 --- a/data/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# This directory is to store the data necessary for the project. - -Use this directory to store a small amount of data which may be used to showcase or demonstrate the use of the project. Please note, due to GitHub's repository size limitations, not all the project's data may be stored in this repository. For projects requiring large amounts of data, it is recommended excessive amounts of data be left outside of this repository, and placed in another type of archive. - -Please be sure to reference the project's data and to describe in this README file how to obtain and setup the data so that it may be used -with the project. This information should also be placed in your Method Section. diff --git a/src/README.md b/src/README.md index 410dbec..624d4f0 100644 --- a/src/README.md +++ b/src/README.md @@ -1,6 +1,6 @@ # Project Prototype -TODO: The result of your work will be the delivery of some type of proof-of-concept prototype which will likely contain software programming solutions (i.e., Python code, HTML pages, or similar). All source code for the prototype must be stored in this directory. +TODO: The result of your work will be the delivery of some type of proof-of-concept prototype which will likely contain software programming solutions (i.e., Python code, HTML pages, or similar). All source code for the prototype must be stored in this directory. If your prototype uses data, please create `data/` subdirectory in `src/` and include your data file(s) in `src/data/` directory. To allow the user to experience and execute your prototype, you must first explain how to set up the initial conditions to run or use the artifact. Be sure to offer explicit details and instructions regarding the installation of the necessary foundational libraries, drivers, external software projects, containers and similar types of tertiary software which are involved in executing your artifact. Once these initial software installations have been completed, then you are asked to offer the necessary instructions for actually executing the artifact. For this, please provide all command line parameters or associated bash commands for execution. Please remember that users are unwilling to "figure-out" how to use code in absence of the essential instructions concerning the execution of project artifacts.