angular/angular: Redaktioneller README-Leitfaden
Ein auf README, Metadaten und Lizenz gestützter Leitfaden für angular/angular.
Projektumfang
angular/angular beschreibt sich im README als „Deliver web apps with confidence 🚀". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „Local Development" steht: To contribute to the Angular Docs, check out the Angular.dev README. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.
Geeignete Einsatzfälle
Der Abschnitt „Prerequisites" zeigt, für welches Problem das Projekt gedacht ist: Install [Node.js] which includes [Node Package Manager][npm]. 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: Install [Node.js] which includes [Node Package Manager][npm]. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.
Funktionsweise
Die Betriebsweise verteilt sich auf Abschnitte wie „Changelog". Die Quelle nennt: [Learn about the latest improvements][changelog].. 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.
Installation und erster Start
Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: npm install -g @angular/cli Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Local Development" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.
Konfiguration und täglicher Betrieb
Der tägliche Betrieb folgt der Projektdokumentation. Im Abschnitt „Upgrading" steht: Check out our upgrade guide to find out the best way to upgrade your project.. 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: Install [Node.js] which includes [Node Package Manager][npm].