ceald1/evilwinrm-ngペネトレーションテスト中にWindowsシステム上でリモートコマンド実行とラテラルムーブメントを行うためのGoベースのWinRMクライアント。
GitLab をすぐに使い始められるよう、推奨する次のステップをまとめました。
すでにプロフェッショナルですか？ この README.md を編集して自分好みにしてください。簡単にしたいですか？ 下部のテンプレートを使用してください！
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.git
git branch -M main
git push -uf origin main
GitLab の組み込み継続的インテグレーションを使用します。
このREADMEを自分好みにする準備ができたら、このファイルを編集して、便利な以下のテンプレートを使用してください（または自由に構造化してください - これは単なる出発点です！）。このテンプレートは makeareadme.com に感謝します。
すべてのプロジェクトは異なるため、これらのセクションのどれがあなたのプロジェクトに当てはまるかを検討してください。テンプレートで使用されているセクションは、ほとんどのオープンソースプロジェクトに対する提案です。また、README は長すぎて詳細になりすぎることはあっても、短すぎるよりは長すぎる方が良いということを覚えておいてください。README が長すぎると思う場合は、情報を削るのではなく、別の形式のドキュメントを利用することを検討してください。
プロジェクトには自己説明的な名前を選んでください。
あなたのプロジェクトが具体的に何ができるかを知らせてください。コンテキストを提供し、訪問者が馴染みのない可能性のある参照へのリンクを追加してください。機能のリストや背景のサブセクションをここに追加することもできます。プロジェクトに代替手段がある場合は、差別化要因をリストするのに適した場所です。
一部のREADMEでは、プロジェクトのすべてのテストが成功しているかどうかなどのメタデータを伝える小さな画像を見ることがあります。Shields を使用して README にバッジを追加できます。多くのサービスにはバッジを追加するための手順もあります。
作っているものによっては、スクリーンショットやビデオを含めることを検討すると良いでしょう（実際のビデオよりもGIFをよく見かけます）。ttygif のようなツールが役立ちますが、より洗練された方法として Asciinema をチェックしてください。
特定のエコシステム内では、Yarn、NuGet、Homebrew など、インストールの一般的な方法があるかもしれません。ただし、あなたの README を読んでいる人が初心者で、より多くのガイダンスを必要としている可能性を考慮してください。具体的な手順をリストすることで曖昧さを取り除き、人々ができるだけ早くプロジェクトを使えるようにします。特定のプログラミング言語バージョンやオペレーティングシステムなどの特定のコンテキストでのみ動作する場合や、手動でインストールする必要がある依存関係がある場合は、要件セクションも追加してください。
例を豊富に使用し、可能であれば期待される出力を示してください。インラインで示せる最も小さな使用例を示すと役立ちます。また、より洗練された例が README に含めるには長すぎる場合は、リンクを提供してください。
人々が助けを求められる場所を教えてください。イシュートラッカー、チャットルーム、メールアドレスなどの任意の組み合わせが可能です。
将来のリリースのアイデアがある場合は、README にリストすることをお勧めします。
コントリビューションを受け入れているかどうか、およびそれを受け入れるための要件を明記してください。
プロジェクトに変更を加えたい人のために、始め方に関するドキュメントを用意しておくと便利です。実行すべきスクリプトや設定すべき環境変数があるかもしれません。これらの手順を明確にしてください。これらの手順は将来の自分にも役立つでしょう。
コードをリントしたりテストを実行するためのコマンドを文書化することもできます。これらの手順は高いコード品質を確保し、変更が不注意に何かを壊す可能性を減らすのに役立ちます。テストの実行手順は、ブラウザでのテストのために Selenium サーバーを起動するなどの外部設定が必要な場合に特に役立ちます。
プロジェクトに貢献した人々に感謝の意を示してください。
オープンソースプロジェクトの場合、ライセンスの方法を記載してください。
プロジェクトにエネルギーや時間がなくなった場合は、README の上部に、開発が減速した、または完全に停止したことを示すメモを追加してください。誰かがプロジェクトをフォークするか、メンテナーまたは所有者として名乗り出て、プロジェクトを継続させてくれるかもしれません。メンテナーを明示的に募集することもできます。