Skip to content

Commit

Permalink
Improved result's README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MischaPanch authored Aug 10, 2024
1 parent 518200e commit 1fb73a0
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ Welcome to the {{cookiecutter.project_name}} library!

## Getting Started

Clone the repository and run
You can have a local poetry or docker-interpeter based setup. The repository is also
configured to seamlessly working within a GitHub Codespace. See the instructions
for the various setup scenarios below.

```shell
git submodule update --init --recursive
```

to also pull the git submodules.
Independently of how the setup was done, the virtual environment can be activated with
`poetry shell` and the various tasks like formatting, testing, and documentation building
can be executed using `poe`. For example, `poe format` will format the code, including the
notebooks. Just run `poe` to see the available commands.

### Python setup
### Python (poetry) setup

You can install the dependencies with

Expand Down

0 comments on commit 1fb73a0

Please sign in to comment.