diff --git a/app/assets/stylesheets/scss/_upload.scss b/app/assets/stylesheets/scss/_upload.scss index 290069fa37..100ed7bb71 100644 --- a/app/assets/stylesheets/scss/_upload.scss +++ b/app/assets/stylesheets/scss/_upload.scss @@ -75,4 +75,12 @@ } .readme-buttons { justify-content: center; +} + +.readme-examples { + list-style-type: none; + padding-left: 0; + i { + margin-right: .5ch; + } } \ No newline at end of file diff --git a/app/javascript/react/components/ReadMeWizard/ReadMeSteps.jsx b/app/javascript/react/components/ReadMeWizard/ReadMeSteps.jsx index df24c5fd71..e63324e6f5 100644 --- a/app/javascript/react/components/ReadMeWizard/ReadMeSteps.jsx +++ b/app/javascript/react/components/ReadMeWizard/ReadMeSteps.jsx @@ -40,10 +40,44 @@ export default function ReadMeSteps({ >, content: content.step2 || formatList(fileList), + examples: [ + { + key: 'nzs7h44xg', + example: + <>View example README (opens in new window) describing data of several file types, including genomic data + >, + }, + { + key: 'rr4xgxdg6', + example: + <>View example README (opens in new window) with a content section describing MATLAB files + >, + }, + { + key: '18931zd25', + example: + <>View example README (opens in new window) with good detail for genomic VCF files + >, + }, + ], }, 3: { desc:
What free or open software is needed to view your data? Describe the software, including versions and loaded packages that you used to run files, and the workflow that you used if the relationship of files to software is not clear. If code or scripts are included with your submission, describe them here.
, content: content.step3 || '', + examples: [ + { + key: 'jdfn2z3j3', + example: + <>View example README (opens in new window) containing excellent information on how to set up, access, and run neural network deep learning code + >, + }, + { + key: 'h70rxwdq5', + example: + <>View example README (opens in new window) with a detailed Recommended Software section + >, + }, + ], }, 4: { desc:If applicable, provide links to other publicly accessible locations of the data. If your data was derived from another source(s), list the source(s) and include license information.
, @@ -62,7 +96,18 @@ export default function ReadMeSteps({ ))} -- Your Dryad submission must be accompanied by a README file, to help others use and understand your + Your Dryad submission must be accompanied by a{' '} + + README file (opens in new window) + , to help others use and understand your dataset. It should contain the details needed to interpret and reuse your data, including abbreviations and codes, file descriptions, and information about any necessary software.
-Here are some outstanding READMEs from Dryad submissions, which show the following:
+