First (way too late) commit
Dumping my fever dream coding session into source control finally.
This commit is contained in:
65
docs/README.md
Normal file
65
docs/README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# DF Tools
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://docs.python.org/3.12/)
|
||||
[](https://github.com/astral-sh/uv)
|
||||
|
||||
This boiler plate hasn't been changed.
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Configure](#configure)
|
||||
- [Running](#running)
|
||||
- [Development Environment](#development-environment)
|
||||
- [Disclosure](#disclosure)
|
||||
- [License](#license)
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
This is where a longer description should be.
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* TODO
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
> [!WARNING]
|
||||
> Don't install it yet. Its not ready for production use.
|
||||
|
||||
TODO: Place instructions for how to install.
|
||||
|
||||
|
||||
## Configure
|
||||
|
||||
> [!NOTE]
|
||||
> Currently nothing to configure
|
||||
|
||||
TODO: Place instructions for how to configure.
|
||||
|
||||
|
||||
## Running
|
||||
|
||||
TODO: Place instructions for how to run.
|
||||
|
||||
|
||||
## Development Environment
|
||||
|
||||
[](https://docs.pytest.org/en/stable/)
|
||||
[](https://github.com/python/mypy)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
|
||||
|
||||
## Disclosure
|
||||
|
||||
|
||||
## License
|
||||
|
||||
`DF Tools` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||
Reference in New Issue
Block a user