Skip to content

Commit fbf0149

Browse files
committed
Revert "Delete README.md" deleted by mistake!
This reverts commit 10640bf.
1 parent 10640bf commit fbf0149

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Introduction
2+
3+
This is a template software project repository used by the [Intermediate Research Software Development Skills In Python](https://github.com/carpentries-incubator/python-intermediate-development).
4+
5+
## Purpose
6+
7+
This repository is intended to be used as a code template which is copied by learners at [Intermediate Research Software Development Skills In Python](https://github.com/carpentries-incubator/python-intermediate-development) course.
8+
This can be done using the `Use this template` button towards the top right of this repo's GitHub page.
9+
10+
This software project is not finished, is currently failing to run and contains some code style issues. It is used as a starting point for the course - issues will be fixed and code will be added in a number of places during the course by learners in their own copies of the repository, as course topics are introduced.
11+
12+
## Tests
13+
14+
Several tests have been implemented already, some of which are currently failing.
15+
These failing tests set out the requirements for the additional code to be implemented during the workshop.
16+
17+
The tests should be run using `pytest`, which will be introduced during the workshop.

0 commit comments

Comments
 (0)