Greg Gauthier
aac0ca084f
Adds a centered image of the WOMM Bronze Certified seal to the README for visual certification display.
69 lines
1.4 KiB
Markdown
69 lines
1.4 KiB
Markdown
# WOMM Certification Toolkit
|
|
|
|
<p align="center">
|
|
<img src="assets/womm-seal-bronze.svg" alt="WOMM Bronze Certified" width="200"/>
|
|
</p>
|
|
|
|
**Works On My Machine -- The Official Certification Standard**
|
|
|
|
A formal certification framework for the age-old claim "it works on my machine," complete with a bureaucratic standards document, an official seal of approval, and a CLI tool to certify your projects.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install -e .
|
|
```
|
|
|
|
For PNG badge export support:
|
|
|
|
```bash
|
|
pip install -e '.[png]'
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Certify a project
|
|
|
|
```bash
|
|
womm certify # certify current directory
|
|
womm certify /path/to/project
|
|
womm certify --level gold # target a specific level
|
|
```
|
|
|
|
### Generate a badge
|
|
|
|
```bash
|
|
womm badge # default: gold, womm-seal.svg
|
|
womm badge --level platinum -o seal.svg
|
|
```
|
|
|
|
### Generate a certificate
|
|
|
|
```bash
|
|
womm certificate # print to stdout
|
|
womm certificate -o cert.txt # save to file
|
|
```
|
|
|
|
### Read the standard
|
|
|
|
```bash
|
|
womm standard
|
|
```
|
|
|
|
## Certification Levels
|
|
|
|
| Level | Requirements |
|
|
|----------|-------------|
|
|
| Bronze | Project exists, has source files, no syntax errors |
|
|
| Silver | Bronze + tests exist and pass |
|
|
| Gold | Silver + README exists, no TODO/FIXME/HACK comments |
|
|
| Platinum | Gold + CI config present, git tree is clean |
|
|
|
|
## The Standard
|
|
|
|
See [WOMM-STD-001:2026](WOMM-STANDARD-001.md) for the full certification standard.
|
|
|
|
## License
|
|
|
|
MIT
|