Skip to content

Commit

Permalink
Merge pull request #16 from ImperialCollegeLondon/update_readme_follo…
Browse files Browse the repository at this point in the history
…wing_move

Update readme following move of repo
  • Loading branch information
alexdewar authored Jun 4, 2024
2 parents 119caf3 + 388a55e commit 804d7b5
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable MD041 -->
[![poetry](https://github.com/alexdewar/cookiecutter-python-template/actions/workflows/ci-poetry.yml/badge.svg)](https://github.com/alexdewar/cookiecutter-python-template/actions/workflows/ci-poetry.yml)
[![pip-tools](https://github.com/alexdewar/cookiecutter-python-template/actions/workflows/ci-pip-tools.yml/badge.svg)](https://github.com/alexdewar/cookiecutter-python-template/actions/workflows/ci-pip-tools.yml)
[![poetry](https://github.com/ImperialCollegeLondon/python-template/actions/workflows/ci-poetry.yml/badge.svg)](https://github.com/ImperialCollegeLondon/python-template/actions/workflows/ci-poetry.yml)
[![pip-tools](https://github.com/ImperialCollegeLondon/python-template/actions/workflows/ci-pip-tools.yml/badge.svg)](https://github.com/ImperialCollegeLondon/python-template/actions/workflows/ci-pip-tools.yml)

# Python project template

Expand All @@ -10,19 +10,25 @@ using [`pytest`].

The template supports two Python packaging tools: [`poetry`] and [`pip-tools`].

It is particularly geared towards the needs of Imperial College's [Research Software
Engineering team], but hopefully it should be generically useful. If you find any
problems or have any questions, please [raise an issue].

[`cookiecutter`]: https://cookiecutter.readthedocs.io/en/stable/
[`pre-commit`]: https://pre-commit.com/
[`pytest`]: https://pytest.org/
[`poetry`]: https://python-poetry.org/
[`pip-tools`]: https://github.com/jazzband/pip-tools
[Research Software Engineering team]: https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/
[raise an issue]: https://github.com/ImperialCollegeLondon/python-template/issues/new

## Usage

To use this template for your own application:

1. [Install `cookiecutter`] following the instructions for your OS.
1. Create your own project using this template: `cookiecutter
gh:alexdewar/cookiecutter-python-template`
gh:ImperialCollegeLondon/python-template`
1. Choose the options you want for your project
1. To get started, follow the instructions in the readme of the newly created project

Expand Down

0 comments on commit 804d7b5

Please sign in to comment.