Skip to content

Commit fa30cff

Browse files
committed
docs: strip the decoration off the readme
Out: the centred div, the wall of shield badges, the hand-written bar of anchor links, and the rule under the intro. None of it said anything the page did not already say further down, and together they read as packaging rather than as a description of the part. In: a plain title, the one line saying what the thing is, and the continuous-integration badge, which is the only one that reports something a reader cannot get from the text. The opening figures stay exactly as they were, separated by commas rather than middots, because the family's own checks read those numbers and so does anybody deciding whether to keep reading.
1 parent e4f1c9e commit fa30cff

1 file changed

Lines changed: 3 additions & 25 deletions

File tree

README.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,10 @@
1-
<div align="center">
1+
# SNES DSP Family
22

3-
<h1>SNES DSP Family</h1>
4-
5-
<strong>The NEC uPD77C25 as Nintendo shipped it, running the microcode you supply rather than a description of it.</strong>
6-
7-
<br>
8-
<br>
3+
The NEC uPD77C25 as Nintendo shipped it, running the microcode you supply rather than a description of it.
94

105
[![CI](https://github.com/gufranco/snes-dsp-python/actions/workflows/ci.yml/badge.svg)](https://github.com/gufranco/snes-dsp-python/actions/workflows/ci.yml)
11-
[![Coverage](https://img.shields.io/badge/coverage-100%25%20statement%20%2B%20branch-brightgreen)](#tests)
12-
[![Python](https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue)](pyproject.toml)
13-
[![Types](https://img.shields.io/badge/mypy-strict-blue)](pyproject.toml)
14-
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
15-
16-
</div>
17-
18-
<p align="center">
19-
<a href="#quick-start">Quick start</a> &nbsp;|&nbsp;
20-
<a href="#the-family">The family</a> &nbsp;|&nbsp;
21-
<a href="#why-there-is-no-model-here">Why there is no model</a> &nbsp;|&nbsp;
22-
<a href="#the-microcode-you-supply">The microcode you supply</a> &nbsp;|&nbsp;
23-
<a href="#driving-it-the-way-a-console-does">Driving it</a> &nbsp;|&nbsp;
24-
<a href="#what-is-checked-without-one">What is checked without one</a> &nbsp;|&nbsp;
25-
<a href="https://github.com/gufranco/snes-dsp-python/issues">Issues</a>
26-
</p>
276

28-
**6** parts across **5** microcodes · **1** processor underneath them all · **0** commands described by hand · **112** exchanges read out of **36** real cartridges compared, **0** failures · **849** tests · **100%** statement and branch coverage · **strict** types throughout · every image confirmed by **SHA-256** before a byte of it runs · no dependencies
7+
**6** parts across **5** microcodes, **1** processor underneath them all, **0** commands described by hand, **112** exchanges read out of **36** real cartridges compared, **0** failures, **849** tests, **100%** statement and branch coverage, **strict** types throughout, every image confirmed by **SHA-256** before a byte of it runs, no dependencies
298

309
```python
3110
from snesdsp import Chip
@@ -41,7 +20,6 @@ for byte in (0x02, 0x00, 0x03, 0x00):
4120
# [6, 0, 0, 0]
4221
```
4322

44-
---
4523

4624
## Install
4725
```bash

0 commit comments

Comments
 (0)