Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add autogenerated basic content to README #116

Merged
merged 3 commits into from
Jul 25, 2023
Merged

Add autogenerated basic content to README #116

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c300da1
Add autogenerated basic content to README
matt-graham Jul 25, 2023
4c2e623
Add text recommending installing in mamba/conda env
matt-graham Jul 25, 2023
e3b98e0
Merge branch 'main' into mmg/auto-readme-sections
matt-graham Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 38 additions & 3 deletions {{cookiecutter.project_slug}}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,54 @@ Centre for Advanced Research Computing, University College London

### Prerequisites

Any tools or versions of languages needed to run code. For example specific Python or Node versions. Minimum hardware requirements also go here.
<!-- Any tools or versions of languages needed to run code. For example specific Python or Node versions. Minimum hardware requirements also go here. -->

`{{cookiecutter.project_slug}}` requires Python {{cookiecutter.min_python_version}}{% if cookiecutter.min_python_version != cookiecutter.max_python_version %}&ndash;{{cookiecutter.max_python_version}}{% endif %}.

### Installation

How to build or install the application.
<!-- How to build or install the application. -->

To install the latest development version of `{{cookiecutter.project_slug}}` using `pip` run

```sh
pip install git+https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.git
```

Alternatively create a local clone of the repository with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to get into the business of setting up a mamba(conda) environment?
It's one of our recommended dev tools.

Copy link
Collaborator Author

@matt-graham matt-graham Jul 25, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - have added a bit of text saying we recommend installing in a virtual environment using a tool like Mamba or Conda with links to their docs - haven't included specific instructions of setting up an environment but hopefully links will be sufficient breadcrumb if people are not familiar how to do this already.


```sh
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.git
```

and then install in editable mode by running

```sh
pip install -e .
```

### Running Locally

How to run the application on your local system.

### Running Tests

How to run tests on your local system.
<!-- How to run tests on your local system. -->

Tests can be run across all compatible Python versions in isolated environments using
[`tox`](https://tox.wiki/en/latest/) by running

```sh
tox
```

To run tests manually in a Python environment with `pytest` installed run

```sh
pytest tests
```

again from the root of the repository.

## Roadmap

Expand Down