Update README

LICENSE.md

@@ -1,9 +1,4 @@
----
-title: "Licenses"
----
-
 ## Instructional Material
-
 All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry)
 instructional material is made available under the [Creative Commons
 Attribution license][cc-by-human]. The following is a human-readable summary of

README.md

@@ -1,72 +1,32 @@
-# The Carpentries Workbench Template Markdown Lesson
+[![pages-build-deployment](https://github.com/christopher-wild/FAIR4RS-Packaging/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/christopher-wild/FAIR4RS-Packaging/actions/workflows/pages/pages-build-deployment)
 
-This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. 
 
-## Note about lesson life cycle stage
-Although the `config.yaml` states the life cycle stage as pre-alpha, **the template is stable and ready to use**. The life cycle stage is preset to `"pre-alpha"` as this setting is appropriate for new lessons initialised using the template.
+# Research Software Documentation
 
-## Create a new repository from this template
+This repository contains a course on documenting research software that is part of the [training provision for research computing](https://sites.google.com/sheffield.ac.uk/research-training/) at the University of Sheffield.
 
-To use this template to start a new lesson repository, 
-make sure you're logged into Github.   
-Visit https://github.com/carpentries/workbench-template-md/generate
-and follow the instructions.
-Checking the 'Include all branches' option will save some time waiting for the first website build
-when your new repository is initialised.
+## Course description
 
-If you have any questions, contact [@tobyhodges](https://github.com/tobyhodges)
+Research software is increasingly becoming a key and fundamental part of research. There is a growing recognition that research software would benefit from adhering to the FAIR principles, which is the main motivation behind the FAIR4RS (Findable, Accessible, Interoperable, Reusable for Research Software) principles. This is an extension of the FAIR principles, which acknowledges the applicability of the FAIR approach to research software. Software packaging has many benefits, such as enabling your research software to be discovered, installed, and utilised with ease.  This course will explore the fundamental concepts of FAIR4RS, how it applies to packaging, its execution within Python, and the adoption of best practices in this domain.
 
-## Configure a new lesson
 
-Follow the steps below to
-complete the initial configuration of a new lesson repository built from this template:
+## Course overview
 
-1. **Make sure GitHub Pages is activated:**
-   navigate to _Settings_,
-   select _Pages_ from the left sidebar,
-   and make sure that `gh-pages` is selected as the branch to build from.
-   If no `gh-pages` branch is available, check _Actions_ to see if the first
-   website build workflows are still running.
-   The branch should become available when those have completed.
-1. **Adjust the `config.yaml` file:**
-   this file contains global parameters for your lesson site.
-   Individual fields within the file are documented with comments (beginning with `#`)
-   At minimum, you should adjust all the fields marked 'FIXME':
-   - `title`
-   - `created`
-   - `keywords`
-   - `life_cycle` (the default, _pre-alpha_, is the appropriate for brand new lessons)
-   - `contact`
-1. **Annotate the repository** with site URL and topic tags:
-   navigate back to the repository landing page and
-   click on the gear wheel/cog icon (similar to ⚙️) 
-   at the top-right of the _About_ box.
-   Check the "Use your GitHub Pages website" option,
-   and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags)
-   in the _Topics_ field.
-   At minimum, these should include:
-   - `lesson`
-   - the life cycle of the lesson (e.g. `pre-alpha`)
-   - the human language the lesson is written in (e.g. `deutsch`)
-1. **Adjust the 
-   `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files**
-   as appropriate for your project.
-   -  `CODE_OF_CONDUCT.md`: 
-      if you are using this template for a project outside The Carpentries,
-      you should adjust this file to describe 
-      who should be contacted with Code of Conduct reports,
-      and how those reports will be handled.
-   -  `CONTRIBUTING.md`:
-      depending on the current state and maturity of your project,
-      the contents of the template Contributing Guide may not be appropriate.
-      You should adjust the file to help guide contributors on how best
-      to get involved and make an impact on your lesson.
-   -  `LICENSE.md`:
-      in line with the terms of the CC-BY license,
-      you should ensure that the copyright information 
-      provided in the license file is accurate for your project.
-1. **Update this README with 
-   [relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)**
-   and delete this section.
+This course introduces the importance of packaging in the context of research software reproducibility. In particular, the course outline is:
 
-[workbench]: https://carpentries.github.io/sandpaper-docs/
+1. Overview FAIR4RS and Software Packaging
+2. History of Python Packaging
+3. Accessing Packages
+4. Versioning
+5. Publishing Python Packages
+
+
+## Prerequisites
+
+- Basic understanding of Python
+- Version control/GitHub
+
+
+# Contact us
+
+Please contact [Research & Innovation IT](https://sheffield.ac.uk/it-services/research) or [Research Software Engineering](https://rse.shef.ac.uk/) at the University of Sheffield.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To report a security problem, please [create a new issue](../../issues/new) using the issue tracker on this repository.