ceald1/evilwinrm-ngClient WinRM basé sur Go pour l'exécution de commandes à distance et le mouvement latéral sur les systèmes Windows lors de tests de pénétration.
Pour faciliter votre prise en main de GitLab, voici une liste des prochaines étapes recommandées.
Déjà un pro ? Modifiez simplement ce README.md et personnalisez-le. Vous voulez faire simple ? Utilisez le modèle en bas de page !
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.git
git branch -M main
git push -uf origin main
Utilisez l'intégration continue intégrée dans GitLab.
Lorsque vous êtes prêt à personnaliser ce README, éditez simplement ce fichier et utilisez le modèle pratique ci-dessous (ou libre à vous de le structurer comme vous le souhaitez – ce n'est qu'un point de départ !). Merci à makeareadme.com pour ce modèle.
Chaque projet est différent, alors réfléchissez aux sections qui s'appliquent au vôtre. Les sections utilisées dans le modèle sont des suggestions pour la plupart des projets open source. Gardez également à l'esprit que même si un README peut être trop long et détaillé, trop long vaut mieux que trop court. Si vous pensez que votre README est trop long, envisagez d'utiliser une autre forme de documentation plutôt que de supprimer des informations.
Choisissez un nom explicite pour votre projet.
Faites savoir aux gens ce que votre projet peut faire concrètement. Fournissez un contexte et ajoutez un lien vers toute référence que les visiteurs pourraient ne pas connaître. Une liste de fonctionnalités ou une sous-section Contexte peut également être ajoutée ici. S'il existe des alternatives à votre projet, c'est un bon endroit pour énumérer les facteurs de différenciation.
Sur certains README, vous pouvez voir de petites images qui transmettent des métadonnées, par exemple si tous les tests passent ou non pour le projet. Vous pouvez utiliser Shields pour en ajouter à votre README. De nombreux services fournissent également des instructions pour ajouter un badge.
Selon ce que vous réalisez, il peut être judicieux d'inclure des captures d'écran ou même une vidéo (vous verrez souvent des GIF plutôt que des vidéos réelles). Des outils comme ttygif peuvent aider, mais consultez Asciinema pour une méthode plus sophistiquée.
Au sein d'un écosystème particulier, il peut exister une manière courante d'installer des choses, comme l'utilisation de Yarn, NuGet ou Homebrew. Cependant, considérez la possibilité que la personne qui lit votre README soit novice et ait besoin de plus de conseils. Énumérer des étapes précises aide à lever les ambiguïtés et permet aux gens d'utiliser votre projet le plus rapidement possible. S'il ne fonctionne que dans un contexte spécifique comme une version particulière d'un langage de programmation ou un système d'exploitation, ou s'il a des dépendances à installer manuellement, ajoutez également une sous-section Prérequis.
Utilisez des exemples généreusement et montrez le résultat attendu si possible. Il est utile d'inclure en ligne le plus petit exemple d'utilisation que vous puissiez démontrer, tout en fournissant des liens vers des exemples plus sophistiqués s'ils sont trop longs pour être raisonnablement inclus dans le README.
Indiquez aux gens où ils peuvent trouver de l'aide. Cela peut être toute combinaison d'un suivi des problèmes, d'un salon de discussion, d'une adresse e-mail, etc.
Si vous avez des idées pour des versions futures, c'est une bonne idée de les lister dans le README.
Indiquez si vous êtes ouvert aux contributions et quelles sont vos exigences pour les accepter.
Pour les personnes qui souhaitent apporter des modifications à votre projet, il est utile d'avoir une documentation sur la façon de commencer. Il peut y avoir un script à exécuter ou des variables d'environnement à définir. Rendez ces étapes explicites. Ces instructions peuvent également être utiles à votre futur vous-même.
Vous pouvez également documenter les commandes pour analyser le code ou exécuter des tests. Ces étapes aident à garantir une haute qualité de code et réduisent la probabilité que les modifications cassent accidentellement quelque chose. Avoir des instructions pour exécuter les tests est particulièrement utile si cela nécessite une configuration externe, comme le démarrage d'un serveur Selenium pour les tests dans un navigateur.
Montrez votre appréciation à ceux qui ont contribué au projet.
Pour les projets open source, indiquez comment il est sous licence.
Si vous manquez d'énergie ou de temps pour votre projet, placez une note en haut du README indiquant que le développement a ralenti ou s'est arrêté complètement. Quelqu'un pourrait décider de forker votre projet ou de se porter volontaire pour intervenir en tant que mainteneur ou propriétaire, permettant ainsi à votre projet de continuer. Vous pouvez également faire une demande explicite de mainteneurs.