Skip to content

Commit 6cb0de2

Browse files
committed
Update README.
1 parent 2d01d1e commit 6cb0de2

File tree

1 file changed

+24
-75
lines changed

1 file changed

+24
-75
lines changed

README.md

Lines changed: 24 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,29 @@
1-
# Building the Site Locally
1+
# Profiling & Optimisation (Python)
22

3-
Both of these steps should be followed within `rterm`.
3+
## Introduction
4+
5+
This lesson introduces the basics of profiling and optimising Python code. The course is designed to be accessible to Python users of all skill levels (beyond total beginner). The optimisations presented should be considered performance best practices, they are demonstrated with small programming patterns that demonstrate multiple approaches in code to achieve the same result with differing performance.
6+
7+
## Contact Us
8+
9+
This course was originally authored by and is currently maintained by [@Robadob](https://github.com/Robadob), it is a fork of the University of Sheffield branded course. Both repositories are maintained, so issues will be monitored .
10+
11+
## Contributing
12+
13+
See [Contributing](CONTRIBUTING.md)
414

5-
## Setup
15+
## Acknowledgements
16+
17+
The initial development of this course was funded by the University of Sheffield, to support training initiatives for users of their [Stanage HPC cluster](https://docs.hpc.shef.ac.uk/en/latest/stanage/index.html).
18+
19+
## Building the Site Locally
20+
21+
If you are making complex changes, and wish to build the site locally the below instructions can be followed.
22+
23+
24+
### Setup
25+
26+
Both of these steps should be followed within `rterm`.
627

728
```r
829
# Setup mirrors
@@ -23,75 +44,3 @@ install.packages(c("sandpaper", "tinkr", "pegboard"))
2344
```r
2445
sandpaper::serve()
2546
```
26-
27-
--------------
28-
29-
# The Carpentries Workbench Template Markdown Lesson
30-
31-
This lesson is a template lesson that uses [The Carpentries Workbench][workbench].
32-
33-
## Create a new repository from this template
34-
35-
To use this template to start a new lesson repository,
36-
make sure you're logged into Github.
37-
Visit https://github.com/carpentries/workbench-template-md/generate
38-
and follow the instructions.
39-
Checking the 'Include all branches' option will save some time waiting for the first website build
40-
when your new repository is initialised.
41-
42-
If you have any questions, contact [@zkamvar](https://github.com/zkamvar)
43-
44-
## Configure a new lesson
45-
46-
Follow the steps below to
47-
complete the initial configuration of a new lesson repository built from this template:
48-
49-
1. **Make sure GitHub Pages is activated:**
50-
navigate to _Settings_,
51-
select _Pages_ from the left sidebar,
52-
and make sure that `gh-pages` is selected as the branch to build from.
53-
If no `gh-pages` branch is available, check _Actions_ to see if the first
54-
website build workflows are still running.
55-
The branch should become available when those have completed.
56-
1. **Adjust the `config.yaml` file:**
57-
this file contains global parameters for your lesson site.
58-
Individual fields within the file are documented with comments (beginning with `#`)
59-
At minimum, you should adjust all the fields marked 'FIXME':
60-
- `title`
61-
- `created`
62-
- `keywords`
63-
- `life_cycle` (the default, _pre-alpha_, is the appropriate for brand new lessons)
64-
- `contact`
65-
1. **Annotate the repository** with site URL and topic tags:
66-
navigate back to the repository landing page and
67-
click on the gear wheel/cog icon (similar to ⚙️)
68-
at the top-right of the _About_ box.
69-
Check the "Use your GitHub Pages website" option,
70-
and [add some keywords and other annotations to describe your lesson](https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags)
71-
in the _Topics_ field.
72-
At minimum, these should include:
73-
- `lesson`
74-
- the life cycle of the lesson (e.g. `pre-alpha`)
75-
- the human language the lesson is written in (e.g. `deutsch`)
76-
1. **Adjust the
77-
`CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, and `LICENSE.md` files**
78-
as appropriate for your project.
79-
- `CODE_OF_CONDUCT.md`:
80-
if you are using this template for a project outside The Carpentries,
81-
you should adjust this file to describe
82-
who should be contacted with Code of Conduct reports,
83-
and how those reports will be handled.
84-
- `CONTRIBUTING.md`:
85-
depending on the current state and maturity of your project,
86-
the contents of the template Contributing Guide may not be appropriate.
87-
You should adjust the file to help guide contributors on how best
88-
to get involved and make an impact on your lesson.
89-
- `LICENSE.md`:
90-
in line with the terms of the CC-BY license,
91-
you should ensure that the copyright information
92-
provided in the license file is accurate for your project.
93-
1. **Update this README with
94-
[relevant information about your lesson](https://carpentries.github.io/lesson-development-training/collaborating-newcomers.html#readme)**
95-
and delete this section.
96-
97-
[workbench]: https://carpentries.github.io/sandpaper-docs/

0 commit comments

Comments
 (0)