ceald1/evilwinrm-ngНаписанный на Go клиент WinRM для удалённого выполнения команд и горизонтального перемещения в Windows-системах во время тестов на проникновение.
Чтобы вам было проще начать работу с 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 о том, что разработка замедлилась или полностью остановлена. Кто-то может решить форкнуть ваш проект или добровольно стать мейнтейнером или владельцем, чтобы проект продолжал развиваться. Вы также можете сделать прямой запрос на мейнтейнеров.