ceald1/evilwinrm-ngClient WinRM basato su Go per l'esecuzione di comandi remoti e movimento laterale su sistemi Windows durante i test di penetrazione.
Per semplificare l'inizio con GitLab, ecco un elenco di passaggi consigliati.
Già un professionista? Modifica questo README.md e personalizzalo. Vuoi renderlo facile? Usa il template in fondo!
cd existing_repo
git remote add origin https://gitlab.com/ceald1/evilwinrm-ng.git
git branch -M main
git push -uf origin main
Usa l'integrazione continua integrata in GitLab.
Quando sei pronto per rendere questo README tuo, modifica questo file e usa il comodo template qui sotto (o sentiti libero di strutturarlo come preferisci - questo è solo un punto di partenza!). Grazie a makeareadme.com per questo template.
Ogni progetto è diverso, quindi considera quali di queste sezioni si applicano al tuo. Le sezioni usate nel template sono suggerimenti per la maggior parte dei progetti open source. Tieni anche presente che mentre un README può essere troppo lungo e dettagliato, troppo lungo è meglio che troppo corto. Se pensi che il tuo README sia troppo lungo, considera di utilizzare un'altra forma di documentazione piuttosto che tagliare via informazioni.
Scegli un nome autoesplicativo per il tuo progetto.
Fai sapere alle persone cosa può fare specificamente il tuo progetto. Fornisci contesto e aggiungi un link a eventuali riferimenti che i visitatori potrebbero non conoscere. Qui può anche essere aggiunto un elenco di funzionalità o una sottosezione di background. Se ci sono alternative al tuo progetto, questo è un buon posto per elencare i fattori di differenziazione.
In alcuni README, potresti vedere piccole immagini che trasmettono metadati, come se tutti i test stanno passando per il progetto. Puoi usare Shields per aggiungerne alcuni al tuo README. Molti servizi hanno anche istruzioni per aggiungere un badge.
A seconda di cosa stai realizzando, può essere una buona idea includere screenshot o anche un video (vedrai frequentemente GIF invece di video reali). Strumenti come ttygif possono aiutare, ma dai un'occhiata a Asciinema per un metodo più sofisticato.
All'interno di un particolare ecosistema, potrebbe esserci un modo comune per installare cose, come usare Yarn, NuGet o Homebrew. Tuttavia, considera la possibilità che chi legge il tuo README sia un principiante e voglia più indicazioni. Elencare passaggi specifici aiuta a rimuovere l'ambiguità e fa sì che le persone usino il tuo progetto il più rapidamente possibile. Se funziona solo in un contesto specifico come una particolare versione del linguaggio di programmazione o sistema operativo o ha dipendenze che devono essere installate manualmente, aggiungi anche una sottosezione Requisiti.
Usa esempi generosamente e mostra l'output previsto se possibile. È utile avere inline il più piccolo esempio di utilizzo che puoi dimostrare, fornendo collegamenti a esempi più sofisticati se sono troppo lunghi per essere ragionevolmente inclusi nel README.
Di' alle persone dove possono andare per ottenere aiuto. Può essere qualsiasi combinazione di un tracker di issue, una chat room, un indirizzo email, ecc.
Se hai idee per versioni future, è una buona idea elencarle nel README.
Indica se sei aperto a contributi e quali sono i tuoi requisiti per accettarli.
Per le persone che vogliono apportare modifiche al tuo progetto, è utile avere della documentazione su come iniziare. Forse c'è uno script che dovrebbero eseguire o alcune variabili d'ambiente che devono impostare. Rendi espliciti questi passaggi. Queste istruzioni potrebbero anche essere utili al tuo futuro te stesso.
Puoi anche documentare comandi per eseguire il lint del codice o eseguire test. Questi passaggi aiutano a garantire un'alta qualità del codice e riducono la probabilità che le modifiche rompano inavvertitamente qualcosa. Avere istruzioni per eseguire i test è particolarmente utile se richiede una configurazione esterna, come l'avvio di un server Selenium per test in un browser.
Mostra il tuo apprezzamento a coloro che hanno contribuito al progetto.
Per progetti open source, indica come è concesso in licenza.
Se hai esaurito energia o tempo per il tuo progetto, inserisci una nota all'inizio del README dicendo che lo sviluppo è rallentato o si è fermato completamente. Qualcuno potrebbe scegliere di forkare il tuo progetto o offrirsi come manutentore o proprietario, permettendo al tuo progetto di continuare. Puoi anche fare una richiesta esplicita di manutentori.