First (way too late) commit

Dumping my fever dream coding session into source control finally.
2026-01-12 19:15:18 -05:00
commit f386b154ab
22 changed files with 3267 additions and 0 deletions
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - not-yet-out
+
+### Added
+
+- [dev] Test for "--version" in CLI
+- This CHANGELOG file to hopefully serve as an evolving example of a
+  standardized open source project CHANGELOG.
--- a/docs/README.md
+++ b/docs/README.md
@@ -0,0 +1,65 @@
+# DF Tools
+
+[![MIT License](https://img.shields.io/github/license/BipolarExpedition/paperbot?style=for-the-badge&logo=mit)](https://opensource.org/licenses/MIT)
+[![Python 3.12+](https://img.shields.io/badge/Python-3.12-blue?style=for-the-badge&logo=python&logoColor=yellow&color=blue)](https://docs.python.org/3.12/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json&style=for-the-badge)](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
+
+[![Pytest](https://img.shields.io/badge/testing-pytest-blue?style=for-the-badge&logo=pytest)](https://docs.pytest.org/en/stable/)
+[![Mypy](https://img.shields.io/badge/types-Mypy-blue?style=for-the-badge)](https://github.com/python/mypy)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=for-the-badge)](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.