ST001: HasReadme

Overview

Checks that a README file exists in the package root directory.

A README file is essential for any package as it provides:

The check looks for any of these files in the package root:

Create a README.md file in your package root:

# My Package

A brief description of what your package does.

## Installation

```bash
pip install my-package

import my_package
# Basic usage example

MIT


## Configuration

### Skip this check

```toml
[tool.pycmdcheck]
skip = ["ST001"]

pycmdcheck --skip ST001