smogon/pokemon-showdown: Redaktioneller README-Leitfaden

smogon/pokemon-showdown beschreibt sich im README als „Pokémon battle simulator.". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „README" steht: Pokémon Showdown ========================================================================. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „README" zeigt, für welches Problem das Projekt gedacht ist: Some command-line tools for simulating Pokémon battles (which can be used in non-JavaScript programs). Passt dieses Problem nicht zu deinem Fall, ist Popularität kein ausreichender Grund. Namen, Befehle und Komponenten bleiben unverändert, damit Leser die Primärquelle ohne neue Begriffe vergleichen können. Ein weiterer überprüfbarer README-Punkt lautet: A JavaScript library for simulating Pokémon battles and getting Pokédex data. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „README". Die Quelle nennt: Introduction ------------------------------------------------------------------------. Fehlende Angaben zu Architektur, Leistung oder Sicherheit werden nicht ergänzt. Vor einem echten Einsatz müssen Repository-Struktur, Konfigurationsdateien und Release-Verlauf geprüft werden.

Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: README 没有给出可直接复制的安装命令。 Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Getting started" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.

Der tägliche Betrieb folgt der Projektdokumentation. Im Abschnitt „README" steht: Pokémon Showdown simulates singles, doubles and triples battles in all the games out so far (Generations 1 through 9).. Konfiguration, Umgebungsvariablen, Rechte und Datenpfade werden nur bei klarer Quelle beschrieben. Unklare Defaults gehören in einen isolierten Test mit rücksetzbarer Konfiguration. Dieselbe Quelle nennt außerdem: A web API for the web site for Pokémon battling.