From 6cb0de27093aedf2f702b8296f8623c06de60bf5 Mon Sep 17 00:00:00 2001 From: Robert Chisholm Date: Mon, 16 Sep 2024 13:00:48 +0100 Subject: [PATCH] Update README. --- README.md | 99 ++++++++++++++----------------------------------------- 1 file changed, 24 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 37d19eb..ce3be6e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,29 @@ -# Building the Site Locally +# Profiling & Optimisation (Python) -Both of these steps should be followed within `rterm`. +## Introduction + +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. + +## Contact Us + +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 . + +## Contributing + +See [Contributing](CONTRIBUTING.md) -## Setup +## Acknowledgements + +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). + +## Building the Site Locally + +If you are making complex changes, and wish to build the site locally the below instructions can be followed. + + +### Setup + +Both of these steps should be followed within `rterm`. ```r # Setup mirrors @@ -23,75 +44,3 @@ install.packages(c("sandpaper", "tinkr", "pegboard")) ```r sandpaper::serve() ``` - --------------- - -# The Carpentries Workbench Template Markdown Lesson - -This lesson is a template lesson that uses [The Carpentries Workbench][workbench]. - -## Create a new repository from this template - -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. - -If you have any questions, contact [@zkamvar](https://github.com/zkamvar) - -## Configure a new lesson - -Follow the steps below to -complete the initial configuration of a new lesson repository built from this template: - -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. - -[workbench]: https://carpentries.github.io/sandpaper-docs/