turned readme list into a checklist

UCSB-MEDS · Sep 3, 2024 · e20579b · e20579b
1 parent fef58be
commit e20579b
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 29 deletions.
diff --git a/index.html b/index.html
@@ -94,7 +94,7 @@ <h1 class="title">MEDS README Guidelines</h1>
     <div>
     <div class="quarto-title-meta-heading">Modified</div>
     <div class="quarto-title-meta-contents">
-      <p class="date-modified">August 29, 2024</p>
+      <p class="date-modified">September 3, 2024</p>
     </div>
   </div>
 
@@ -142,55 +142,55 @@ <h3 class="anchored" data-anchor-id="always-include">Things you should <em>alway
 <p>These core elements are required for <em>all</em> MEDS-related homework assignments and projects.</p>
 </div>
 </div>
-<ol type="1">
-<li><span class="teal-text"><strong>A short, but descriptive title</strong></span>
+<ul class="task-list">
+<li><label><input type="checkbox"><span class="teal-text"><strong>A short, but descriptive title</strong></span></label>
 <ul>
 <li>A README’s title is set to the repository name by default - change this!</li>
 </ul></li>
-<li><span class="teal-text"><strong>A brief explanation of the repository’s purpose</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>A brief explanation of the repository’s purpose</strong></span></label>
 <ul>
 <li>Paragraphs or a bulleted list are both acceptable options</li>
 <li>You may include an image or logo that represents the project</li>
 </ul></li>
-<li><span class="teal-text"><strong>A concise description of what’s housed in the repository</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>A concise description of what’s housed in the repository</strong></span></label>
 <ul>
 <li>This includes information about the repository structure or file organization</li>
 </ul></li>
-<li><span class="teal-text"><strong>Details regarding data access</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>Details regarding data access</strong></span></label>
 <ul>
 <li>Any necessary information on where data lives (e.g.&nbsp;is it housed in the repo, on a server, in a library/package etc.) and how to access it in order to run the code</li>
 </ul></li>
-<li><span class="teal-text"><strong>A list of authors or current contributors (for collaborative work)</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>A list of authors or current contributors (for collaborative work)</strong></span></label>
 <ul>
 <li>Consider hyperlinking collaborators’ GitHub profiles or other professional profile</li>
 </ul></li>
-<li><span class="teal-text"><strong>References</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>References</strong></span></label>
 <ul>
 <li>In an appropriate, consistent format, including links</li>
 <li>Don’t forget to add references for data sets too</li>
 </ul></li>
-</ol>
+</ul>
 </section>
 <section id="consider-including" class="level3">
 <h3 class="anchored" data-anchor-id="consider-including">Things you should consider including, but may vary depending on the goals and complexity of the project:</h3>
-<ol type="1">
-<li><span class="teal-text"><strong>How to install or where to start</strong></span>
+<ul class="task-list">
+<li><label><input type="checkbox"><span class="teal-text"><strong>How to install or where to start</strong></span></label>
 <ul>
 <li>Does your repository contain software that users will need to download or install? Do users access your software via a web browser? Do they need to install any dependencies? Do users need to clone your repository? etc.</li>
 </ul></li>
-<li><span class="teal-text"><strong>A quick demo</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>A quick demo</strong></span></label>
 <ul>
 <li>Related to #1, above. Its important to keep this concise! You may include images. Any long-form instructional documentation is best moved to the repository’s wiki</li>
 </ul></li>
-<li><span class="teal-text"><strong>What do do if a bug is spotted</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>What do do if a bug is spotted</strong></span></label>
 <ul>
 <li>Make mention of GitHub issues and what information a user should include in an issue</li>
 </ul></li>
-<li><span class="teal-text"><strong>Contributing</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>Contributing</strong></span></label>
 <ul>
 <li>Do you welcome contributions from others? If so, its important to explain how one might contribute (e.g.&nbsp;fork &amp; pull request, open an issue, both?)</li>
 </ul></li>
-<li><span class="teal-text"><strong>License</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>License</strong></span></label>
 <ul>
 <li>Important for allowing others to reuse your work (which is copyrighted, by default; <a href="https://choosealicense.com/no-permission/">read about what it means when no license is available</a>)</li>
 <li>What license you choose depends on what type of work you are trying to license. There are different licenses used for code/software, content, and data. Some helpful resources for getting started:
@@ -200,11 +200,11 @@ <h3 class="anchored" data-anchor-id="consider-including">Things you should consi
 <li><em>Licensing data:</em> You’ll chat more about this in <a href="https://bren.ucsb.edu/courses/eds-213">EDS 213 (Databases and Data Management)</a>!</li>
 </ol></li>
 </ul></li>
-<li><span class="teal-text"><strong>Acknowledgements</strong></span>
+<li><label><input type="checkbox"><span class="teal-text"><strong>Acknowledgements</strong></span></label>
 <ul>
 <li>Provide reference to any other individuals or sources that supported the development of the repository. For example, did you fork an existing repository? Did the work have any funding sources? Were there individuals you consulted with or were inspired by?</li>
 </ul></li>
-</ol>
+</ul>
 <div class="callout callout-style-default callout-note callout-titled">
 <div class="callout-header d-flex align-content-center">
 <div class="callout-icon-container">

diff --git a/sections/repo-READMEs.qmd b/sections/repo-READMEs.qmd
@@ -19,38 +19,38 @@ format:
 These core elements are required for *all* MEDS-related homework assignments and projects.
 :::
 
-1. [**A short, but descriptive title**]{.teal-text} 
+- [ ] [**A short, but descriptive title**]{.teal-text} 
     - A README’s title is set to the repository name by default - change this!
-2. [**A brief explanation of the repository's purpose**]{.teal-text} 
+- [ ] [**A brief explanation of the repository's purpose**]{.teal-text} 
     - Paragraphs or a bulleted list are both acceptable options
     - You may include an image or logo that represents the project
-3. [**A concise description of what’s housed in the repository**]{.teal-text} 
+- [ ] [**A concise description of what’s housed in the repository**]{.teal-text} 
     - This includes information about the repository structure or file organization
-4. [**Details regarding data access**]{.teal-text} 
+- [ ] [**Details regarding data access**]{.teal-text} 
    - Any necessary information on where data lives (e.g. is it housed in the repo, on a server, in a library/package etc.) and how to access it in order to run the code
-5. [**A list of authors or current contributors (for collaborative work)**]{.teal-text} 
+- [ ] [**A list of authors or current contributors (for collaborative work)**]{.teal-text} 
     - Consider hyperlinking collaborators' GitHub profiles or other professional profile
-6. [**References**]{.teal-text}  
+- [ ] [**References**]{.teal-text}  
     - In an appropriate, consistent format, including links
     - Don't forget to add references for data sets too
 
 ### Things you should consider including, but may vary depending on the goals and complexity of the project: {#consider-including}
 
-1. [**How to install or where to start**]{.teal-text} 
+- [ ] [**How to install or where to start**]{.teal-text} 
     - Does your repository contain software that users will need to download or install? Do users access your software via a web browser? Do they need to install any dependencies? Do users need to clone your repository? etc.
-2. [**A quick demo**]{.teal-text} 
+- [ ] [**A quick demo**]{.teal-text} 
     - Related to #1, above. Its important to keep this concise! You may include images. Any long-form instructional documentation is best moved to the repository's wiki
-3. [**What do do if a bug is spotted**]{.teal-text} 
+- [ ] [**What do do if a bug is spotted**]{.teal-text} 
     - Make mention of GitHub issues and what information a user should include in an issue
-4. [**Contributing**]{.teal-text} 
+- [ ] [**Contributing**]{.teal-text} 
     - Do you welcome contributions from others? If so, its important to explain how one might contribute (e.g. fork & pull request, open an issue, both?)
-5. [**License**]{.teal-text} 
+- [ ] [**License**]{.teal-text} 
     - Important for allowing others to reuse your work (which is copyrighted, by default; [read about what it means when no license is available](https://choosealicense.com/no-permission/))
     - What license you choose depends on what type of work you are trying to license. There are different licenses used for code/software, content, and data. Some helpful resources for getting started: 
         a. *Licensing code / software:* check out this page,[ Choose an open source license](https://choosealicense.com/), by GitHub. A couple popular options for software include [MIT License](https://choosealicense.com/licenses/mit/) and [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
         b. *Licensing content (i.e. non-software):* check out this page, [About CC Licenses](https://creativecommons.org/share-your-work/cclicenses/), by Creative Commons. A few good CC options for non-software content include [CC BY](https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1), [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/), and [CC BY-NC](https://creativecommons.org/licenses/by-nc/4.0/).
         c. *Licensing data:* You'll chat more about this in [EDS 213 (Databases and Data Management)](https://bren.ucsb.edu/courses/eds-213)!
-6. [**Acknowledgements**]{.teal-text}
+- [ ] [**Acknowledgements**]{.teal-text}
     - Provide reference to any other individuals or sources that supported the development of the repository. For example, did you fork an existing repository? Did the work have any funding sources? Were there individuals you consulted with or were inspired by?
 
 ::: {.callout-note}