Metadata-Version: 2.4
Name: technical-manual-toolkit
Version: 1.2.0
Summary: Technical Manual Toolkit
Author: Aleksandar Šalamon
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=9.1.1; extra == "dev"
Dynamic: license-file

# Technical Manual Toolkit (TMT)

Technical Manual Toolkit (TMT) is a command-line application for creating,
validating, and building structured technical manuals.

The project produces professional documentation in a consistent and repeatable way,
publishing both Markdown and HTML output from plain Markdown source files.

---

## Features

- Initialise a new technical manual project (`tmt init`)
- Validate project structure (`tmt validate`)
- Generate a compiled Markdown manual (`build/manual.md`)
- Publish a standalone HTML manual (`build/manual.html`)
- Quality gate validation for figures, tables, appendices, and cross-references
- Build report in text, Markdown, or HTML format
- Standard library only — no external dependencies

---

## Requirements

- Python 3.11 or newer

---

## Installation

Clone the repository:

```bash
git clone https://github.com/alsalamon/tmt.git
cd tmt
```

Install the package:

```bash
pip install -e .
```

Verify the installation:

```bash
python -m tmt --version
```

See [INSTALL.md](INSTALL.md) for full installation details.

---

## Quick Start

```bash
# 1. Create a new project
mkdir my-manual && cd my-manual
python -m tmt init

# 2. Edit your content
edit manuscript/chapters/01-introduction.md

# 3. Validate the project
python -m tmt validate

# 4. Build the manual
python -m tmt build

# 5. Open the result
open build/manual.html
```

See [QUICKSTART.md](QUICKSTART.md) for a step-by-step guide.

---

## Available Commands

| Command | Description |
|---------|-------------|
| `python -m tmt --version` | Print version and exit |
| `python -m tmt version` | Display full version string |
| `python -m tmt init` | Initialise a new project |
| `python -m tmt validate` | Validate project structure |
| `python -m tmt build` | Build the technical manual |

---

## Typical Workflow

```text
tmt init        →  Create project structure
  ↓
Author content  →  Edit manuscript files
  ↓
tmt validate    →  Check project structure
  ↓
tmt build       →  Compile and publish
  ↓
build/manual.md
build/manual.html
```

---

## Project Structure

```text
my-manual/
│
├── manuscript/
│   ├── chapters/
│   └── appendices/
│
├── assets/
│   └── images/
│
├── data/
├── docs/
├── build/
│   ├── manual.md
│   └── manual.html
│
├── tmt.toml
├── README.md
├── CHANGELOG.md
└── ROADMAP.md
```

---

## Documentation

- [INSTALL.md](INSTALL.md) — Installation guide
- [QUICKSTART.md](QUICKSTART.md) — Quick start guide
- [USER-GUIDE.md](USER-GUIDE.md) — Full user guide
- [RELEASE-NOTES.md](RELEASE-NOTES.md) — Release notes

---

## Tests

Run all unit tests:

```bash
python -m pytest
```

---

## License

See the [LICENSE](LICENSE) file included in the project.
