ceald1/evilwinrm-ngGo-basierter WinRM-Client für die Fernausführung von Befehlen und laterale Bewegung auf Windows-Systemen während Penetrationstests.
Um Ihnen den Einstieg in GitLab zu erleichtern, finden Sie hier eine Liste empfohlener nächster Schritte.
Bereits ein Profi? Bearbeiten Sie einfach diese README.md und machen Sie sie zu Ihrer eigenen. Möchten Sie es einfach haben? Verwenden Sie die Vorlage unten.
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.git
git branch -M main
git push -uf origin main
Nutzen Sie die integrierte Continuous Integration in GitLab.
Wenn Sie bereit sind, diese README zu Ihrer eigenen zu machen, bearbeiten Sie einfach diese Datei und verwenden Sie die praktische Vorlage unten (oder gestalten Sie sie nach Ihren Wünschen – dies ist nur ein Ausgangspunkt!). Danke an makeareadme.com für diese Vorlage.
Jedes Projekt ist anders; überlegen Sie, welche dieser Abschnitte für Ihr Projekt zutreffen. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open-Source-Projekte. Beachten Sie auch, dass eine README zwar zu lang und detailliert sein kann, aber zu lang ist besser als zu kurz. Wenn Sie denken, dass Ihre README zu lang ist, ziehen Sie eine andere Form der Dokumentation in Betracht, anstatt Informationen wegzulassen.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Teilen Sie mit, was Ihr Projekt genau kann. Geben Sie Kontext und fügen Sie einen Link zu einer Referenz hinzu, die Besuchern möglicherweise unbekannt ist. Eine Liste der Funktionen oder ein Abschnitt mit Hintergrundinformationen können ebenfalls hinzugefügt werden. Wenn es Alternativen zu Ihrem Projekt gibt, ist dies ein guter Ort, um die Unterschiede zu nennen.
Auf manchen READMEs sehen Sie kleine Bilder, die Metadaten übermitteln, z. B. ob alle Tests für das Projekt bestanden werden. Sie können Shields verwenden, um einige zu Ihrer README hinzuzufügen. Viele Dienste haben auch Anleitungen zum Hinzufügen eines Badges.
Je nachdem, was Sie erstellen, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzufügen (Sie sehen oft GIFs anstelle von tatsächlichen Videos). Werkzeuge wie ttygif können helfen, aber sehen Sie sich Asciinema für eine ausgefeiltere Methode an.
Innerhalb eines bestimmten Ökosystems gibt es möglicherweise eine übliche Installationsmethode, z. B. mit Yarn, NuGet oder Homebrew. Bedenken Sie jedoch, dass der Leser Ihrer README ein Anfänger sein könnte und mehr Anleitung benötigt. Das Auflisten spezifischer Schritte hilft, Unklarheiten zu beseitigen, und ermöglicht es den Leuten, Ihr Projekt so schnell wie möglich zu nutzen. Wenn es nur in einem bestimmten Kontext läuft, z. B. einer bestimmten Programmiersprachenversion oder einem bestimmten Betriebssystem, oder Abhängigkeiten vorhanden sind, die manuell installiert werden müssen, fügen Sie auch einen Abschnitt mit den Anforderungen hinzu.
Verwenden Sie großzügig Beispiele und zeigen Sie die erwartete Ausgabe, wenn möglich. Es ist hilfreich, das kleinste Beispiel der Verwendung, das Sie demonstrieren können, inline zu haben, und gleichzeitig Links zu anspruchsvolleren Beispielen bereitzustellen, falls diese zu lang sind, um sie sinnvoll in die README aufzunehmen.
Teilen Sie mit, wohin sich die Leute wenden können, um Hilfe zu erhalten. Dies kann eine Kombination aus Issue-Tracker, Chat-Raum, E-Mail-Adresse usw. sein.
Wenn Sie Ideen für zukünftige Veröffentlichungen haben, ist es eine gute Idee, diese in der README aufzulisten.
Geben Sie an, ob Sie offen für Beiträge sind und welche Anforderungen Sie für deren Annahme haben.
Für Personen, die Änderungen an Ihrem Projekt vornehmen möchten, ist es hilfreich, einige Dokumentationen zum Einstieg zu haben. Möglicherweise gibt es ein Skript, das sie ausführen sollen, oder Umgebungsvariablen, die sie setzen müssen. Machen Sie diese Schritte explizit. Diese Anweisungen können auch für Ihr zukünftiges Ich nützlich sein.
Sie können auch Befehle zum Linten des Codes oder zum Ausführen von Tests dokumentieren. Diese Schritte helfen, eine hohe Codequalität sicherzustellen und die Wahrscheinlichkeit zu verringern, dass die Änderungen unbeabsichtigt etwas kaputt machen. Anleitungen zum Ausführen von Tests sind besonders hilfreich, wenn eine externe Einrichtung erforderlich ist, z. B. das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeigen Sie Ihre Wertschätzung für diejenigen, die zum Projekt beigetragen haben.
Für Open-Source-Projekte: Geben Sie an, wie es lizenziert ist.
Wenn Ihnen die Energie oder Zeit für Ihr Projekt ausgeht, fügen Sie oben in der README einen Hinweis ein, dass die Entwicklung verlangsamt oder vollständig eingestellt wurde. Jemand könnte sich entscheiden, Ihr Projekt zu forken oder sich freiwillig als Maintainer oder Eigentümer zu melden, damit Ihr Projekt weitergeführt werden kann. Sie können auch eine explizite Anfrage nach Maintainern stellen.