Kitware/ParaView: Redaktioneller README-Leitfaden

Kitware/ParaView beschreibt sich im README als „VTK-based Data Analysis and Visualization Application". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „README" steht: Introduction ============ [ParaView][] is an open-source, multi-platform data analysis and visualization application based on [Visualization Toolkit (VTK)][VTK].. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „README" zeigt, für welches Problem das Projekt gedacht ist: The ParaView User's Guide can be found on the [ParaView Documentation][Guide].. 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: General information is available at the [ParaView Homepage][].. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „README". Die Quelle nennt: [ParaView]: https://www.paraview.org [VTK]: https://www.vtk.org [Kitware]: https://www.kitware.com [Sandia]: https://www.sandia.gov/ [LANL]: https://www.lanl.gov/ [ARL]: https://www.arl.army.mil/. 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.