Built site for gh-pages

lmu-osc · Sep 8, 2024 · 9bdbd86 · 9bdbd86
1 parent 654f4d0
commit 9bdbd86
Show file tree

Hide file tree

Showing 10 changed files with 169 additions and 169 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-44f91ae7
+69e4d758
diff --git a/about.html b/about.html
@@ -221,8 +221,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">

diff --git a/archive.html b/archive.html
@@ -50,7 +50,7 @@
 <script src="site_libs/quarto-search/fuse.min.js"></script>
 <script src="site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="./">
-<link href="./add_readme.html" rel="prev">
+<link href="./make_readme.html" rel="prev">
 <link href="./images/LMU-OSC_favicon.jpg" rel="icon" type="image/jpeg">
 <script src="site_libs/quarto-html/quarto.js"></script>
 <script src="site_libs/quarto-html/popper.min.js"></script>
@@ -185,8 +185,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">
@@ -683,8 +683,8 @@ <h1 class="title">Archive</h1>
 </script>
 <nav class="page-navigation">
   <div class="nav-page nav-page-previous">
-      <a href="./add_readme.html" class="pagination-link" aria-label="Add a README">
-        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Add a README</span>
+      <a href="./make_readme.html" class="pagination-link" aria-label="Make a README">
+        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Make a README</span>
       </a>          
   </div>
   <div class="nav-page nav-page-next">

diff --git a/choose_license.html b/choose_license.html
@@ -84,7 +84,7 @@
 <script src="site_libs/quarto-search/fuse.min.js"></script>
 <script src="site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="./">
-<link href="./add_readme.html" rel="next">
+<link href="./make_readme.html" rel="next">
 <link href="./setup.html" rel="prev">
 <link href="./images/LMU-OSC_favicon.jpg" rel="icon" type="image/jpeg">
 <script src="site_libs/quarto-html/quarto.js"></script>
@@ -227,8 +227,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">
@@ -339,7 +339,7 @@ <h2 class="anchored" data-anchor-id="which-license-to-choose">Which License to C
 <p><img src="images/Definition_of_Free_Cultural_Works.svg" class="img-fluid" width="250"></p>
 </div></div><section id="existing-license" class="level3 page-columns page-full">
 <h3 class="anchored" data-anchor-id="existing-license">Existing License?</h3>
-<div class="page-columns page-full"><p>First, if you adapt (i.e., modify, build on) a work by others you need to determine if it is provided to you under a free/open license. If yes, we we recommend you to make your contribution available under the same license.<a href="#fn3" class="footnote-ref" id="fnref3" role="doc-noteref"><sup>3</sup></a> For example, if you adapt code published in another paper, choose the same license for your modifications. The same applies if there are strong community norms to use a particular free/open license.<a href="#fn4" class="footnote-ref" id="fnref4" role="doc-noteref"><sup>4</sup></a> Importantly, as discussed before, you are generally not allowed to adapt a work <em>not</em> published under a free/open license.</p><div class="no-row-height column-margin column-container"><span class="margin-aside">You can determine whether a license is free/open by searching for its name in the <a href="https://spdx.org/licenses/">SPDX License List</a> and looking for at least one <code>Y</code> in the two columns <em>FSF Free/Libre?</em> and <em>OSI Approved?</em></span></div></div>
+<div class="page-columns page-full"><p>First, if you adapt (i.e., modify, build on) a work by others you need to determine if it is provided to you under a free/open license. If yes, we recommend you to make your contribution available under the same license.<a href="#fn3" class="footnote-ref" id="fnref3" role="doc-noteref"><sup>3</sup></a> For example, if you adapt code published in another paper, choose the same license for your modifications. The same applies if there are strong community norms to use a particular free/open license.<a href="#fn4" class="footnote-ref" id="fnref4" role="doc-noteref"><sup>4</sup></a> Importantly, as discussed before, you are generally not allowed to adapt a work <em>not</em> published under a free/open license.</p><div class="no-row-height column-margin column-container"><span class="margin-aside">You can determine whether a license is free/open by searching for its name in the <a href="https://spdx.org/licenses/">SPDX License List</a> and looking for at least one <code>Y</code> in the two columns <em>FSF Free/Libre?</em> and <em>OSI Approved?</em></span></div></div>
 </section>
 <section id="work-type" class="level3">
 <h3 class="anchored" data-anchor-id="work-type">Work Type?</h3>
@@ -480,7 +480,7 @@ <h3 class="anchored" data-anchor-id="attribution-state-changes-and-anti-drm">Att
 </section>
 <section id="applying-the-license" class="level2">
 <h2 class="anchored" data-anchor-id="applying-the-license">Applying the License</h2>
-<p>Having selected the licenses of your choice – you might need multiple ones depending on the types of works your project contains –, we encourage you to read through the full license text (or at least a legal summary) to understand their effect. Then, you can record the license of existing content and apply the licenses of your own contributions. Mostly, this just means indicating which license applies to which file or folder, usually in the project’s README (among other places), whose creation will be discussed in “<a href="./add_readme.html">Add a README</a>”.</p>
+<p>Having selected the licenses of your choice – you might need multiple ones depending on the types of works your project contains –, we encourage you to read through the full license text (or at least a legal summary) to understand their effect. Then, you can record the license of existing content and apply the licenses of your own contributions. Mostly, this just means indicating which license applies to which file or folder, usually in the project’s README (among other places), whose creation will be discussed in “<a href="add_readme.qmd">Add a README</a>”.</p>
 <div id="cau-license-versions" class="callout callout-style-default callout-caution callout-titled">
 <div class="callout-header d-flex align-content-center">
 <div class="callout-icon-container">
@@ -1273,8 +1273,8 @@ <h2 class="anchored" data-anchor-id="wrap-up">Wrap-up</h2>
       </a>          
   </div>
   <div class="nav-page nav-page-next">
-      <a href="./add_readme.html" class="pagination-link" aria-label="Add a README">
-        <span class="nav-page-text">Add a README</span> <i class="bi bi-arrow-right-short"></i>
+      <a href="./make_readme.html" class="pagination-link" aria-label="Make a README">
+        <span class="nav-page-text">Make a README</span> <i class="bi bi-arrow-right-short"></i>
       </a>
   </div>
 </nav>
@@ -1292,7 +1292,7 @@ <h2 class="anchored" data-anchor-id="wrap-up">Wrap-up</h2>
     </div>
   </div>
 </footer>
-<script>var lightboxQuarto = GLightbox({"selector":".lightbox","closeEffect":"zoom","descPosition":"bottom","openEffect":"zoom","loop":false});
+<script>var lightboxQuarto = GLightbox({"loop":false,"selector":".lightbox","descPosition":"bottom","closeEffect":"zoom","openEffect":"zoom"});
 (function() {
   let previousOnload = window.onload;
   window.onload = () => {

diff --git a/index.html b/index.html
@@ -164,8 +164,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">
@@ -219,7 +219,7 @@ <h2 class="anchored" data-anchor-id="content">Content</h2>
 <p>We will start with creating a simple report which incorporates R code. Then, we will focus on what is required to publish your work:</p>
 <ul>
 <li>removing legal barriers: adding an appropriate license</li>
-<li>high-level documentation: adding a README file</li>
+<li>high-level documentation: creating a README file</li>
 <li>archival: uploading it to a repository</li>
 </ul>
 </section>

diff --git a/intro.html b/intro.html
@@ -185,8 +185,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">

diff --git a/add_readme.html → make_readme.html b/add_readme.html → make_readme.html
@@ -7,7 +7,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
 
-<title>Add a README – Code Publishing Tutorial</title>
+<title>Make a README – Code Publishing Tutorial</title>
 <style>
 code{white-space: pre-wrap;}
 span.smallcaps{font-variant: small-caps;}
@@ -189,7 +189,7 @@
       <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" role="button" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
         <i class="bi bi-layout-text-sidebar-reverse"></i>
       </button>
-        <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./add_readme.html">Add a README</a></li></ol></nav>
+        <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="./make_readme.html">Make a README</a></li></ol></nav>
         <a class="flex-grow-1" role="navigation" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">      
         </a>
       <button type="button" class="btn quarto-search-button" aria-label="Search" onclick="window.quartoOpenSearch();">
@@ -229,8 +229,8 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="./add_readme.html" class="sidebar-item-text sidebar-link active">
- <span class="menu-text">Add a README</span></a>
+  <a href="./make_readme.html" class="sidebar-item-text sidebar-link active">
+ <span class="menu-text">Make a README</span></a>
   </div>
 </li>
         <li class="sidebar-item">
@@ -253,14 +253,14 @@ <h2 id="toc-title">On this page</h2>
   <ul>
   <li><a href="#creating-a-readme" id="toc-creating-a-readme" class="nav-link active" data-scroll-target="#creating-a-readme">Creating a README</a></li>
   </ul>
-<div class="toc-actions"><ul><li><a href="https://github.com/lmu-osc/code-publishing/edit/main/add_readme.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/lmu-osc/code-publishing/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
+<div class="toc-actions"><ul><li><a href="https://github.com/lmu-osc/code-publishing/edit/main/make_readme.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/lmu-osc/code-publishing/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
     </div>
 <!-- main -->
 <main class="content" id="quarto-document-content">
 
 <header id="title-block-header" class="quarto-title-block default">
 <div class="quarto-title">
-<h1 class="title">Add a README</h1>
+<h1 class="title">Make a README</h1>
 </div>
 
 
@@ -279,7 +279,7 @@ <h1 class="title">Add a README</h1>
 
 <section id="creating-a-readme" class="level2">
 <h2 class="anchored" data-anchor-id="creating-a-readme">Creating a README</h2>
-<p>Once you have prepared your project and settled on a license, it is time to add a final touch. Imagine you are coming back to your project in five years, having forgotten most of the details of what you did exactly. What would be useful to know in order to quickly understand what is going on in the project? This is what needs to be described in the README. While you could just start writing along, most READMEs have some sections in common which we describe below.</p>
+<p>Once you have prepared your project and settled on a license, it is time to add a final touch. Imagine returning to your project in five years, having forgotten most of the details of what you did exactly. What would be useful to know in order to quickly understand what is going on in the project? This is what needs to be described in the README. While you could just start writing along, most READMEs have some sections in common which we describe below.</p>
 <dl>
 <dt>Name</dt>
 <dd>
@@ -295,7 +295,7 @@ <h2 class="anchored" data-anchor-id="creating-a-readme">Creating a README</h2>
 </dd>
 <dt>Visuals</dt>
 <dd>
-<p>If there is anything you can show that demonstrates how the project can be used? Screenshots or other visuals can make the README more appealing.</p>
+<p>Is there anything you can show that demonstrates how the project can be used? Screenshots or other visuals can make the README more appealing.</p>
 </dd>
 <dt>Installation/Dependencies</dt>
 <dd>
@@ -368,7 +368,7 @@ <h2 class="anchored" data-anchor-id="creating-a-readme">Creating a README</h2>
 </dd>
 <dt>Citation</dt>
 <dd>
-<p>Is there a recommended way to cite this project? We recommend to increase citability by using the <a href="https://codemeta.github.io/codemeta-generator/">CodeMeta generator</a> to create the file <code>codemeta.json</code>. Alternatively, one can also use the R package <a href="https://docs.ropensci.org/codemetar/"><code>codemetar</code></a> to create the file.</p>
+<p>Is there a recommended way to cite this project? We recommend to increase citability by using the <a href="https://codemeta.github.io/codemeta-generator/">CodeMeta generator</a> to create a file called <code>codemeta.json</code>. Alternatively, one can also use the R package <a href="https://docs.ropensci.org/codemetar/"><code>codemetar</code></a> to create this file. Then, put it into the project folder.</p>
 </dd>
 <dt>License</dt>
 <dd>
@@ -827,7 +827,7 @@ <h2 class="anchored" data-anchor-id="creating-a-readme">Creating a README</h2>
     </div>   
     <div class="nav-footer-center">
 <p>Copyright 2024 Open Science Center at LMU Munich</p>
-<div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/lmu-osc/code-publishing/edit/main/add_readme.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/lmu-osc/code-publishing/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
+<div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/lmu-osc/code-publishing/edit/main/make_readme.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/lmu-osc/code-publishing/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
     <div class="nav-footer-right">
       &nbsp;
     </div>