diff --git a/it/README_TEMPLATES/Bot.md b/it/README_TEMPLATES/Bot.md index e69de29..c97aa51 100644 --- a/it/README_TEMPLATES/Bot.md +++ b/it/README_TEMPLATES/Bot.md @@ -0,0 +1,143 @@ +

+ + Bot logo +

+ +

Nome del Bot

+ +
+ +[![Status](https://img.shields.io/badge/status-active-success.svg)]() +[![Platform](https://img.shields.io/badge/platform-reddit-orange.svg)](https://www.reddit.com/user/Wordbook_Bot) +[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

🤖 Qualche riga per descrivere le funzionalità del tuo bot. +
+

+ +## 📝 Table of Contents + +- [Descrizione](#about) +- [Demo / Funzionamento](#demo) +- [Come Funziona](#working) +- [Utilizzo](#usage) +- [Come Iniziare](#getting_started) +- [Deployare il tuo bot](#deployment) +- [Costruito Con](#built_using) +- [TODO](../TODO.md) +- [Contribuire](../CONTRIBUTING.md) +- [Autori](#authors) +- [Riconoscimenti](#acknowledgement) + +## 🧐 Descrizione + +Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo bot. + +## 🎥 Demo / Funzionamento + +![Funzionamento](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif) + +## 💭 Come Funziona + +Il bot per prima cosa estrae la parola dal commento e poi ottiene le definizioni, parte del discorso, esempio e fonte dalla API di Oxford Dictionary. + +Se la parola non esiste in Oxford Dictionary, l'API Oxford restituisce una risposta 404, per cui il bot prova ad ottenere risulati dall'API di Urban Dictionary. + +Il bot usa Pushshift API per ottenere commenti, PRAW module per rispondere ai commenti e Heroku come server. + +Per intero il bot è scritto in Python 3.6 + +## 🎈 Utilizzo + +Per usare il bot, scrivi: + +``` +!dict word +``` + +La prima parte, i.e. "!dict" **non** tiene conto del maiuscolo o minuscolo. + +Il bot quindi ti darò la definizione secondo Oxford Dictionary (o Urban Dictionary; se la parola non esiste in Oxford Dictionary) come risposta. + +### Esempio: + +> !dict what is love + +**Definition:** + +Baby, dont hurt me~ +Dont hurt me~ no more. + +**Example:** + +Dude1: Bruh, what is love? +Dude2: Baby, dont hurt me, dont hurt me- no more! +Dude1: dafuq? + +**Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love + +--- + +Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot) + +Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot) + +## 🏁 Come Iniziare + +Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto. + +### Prerequisiti + +Di cosa hai bisogno per installare il software e come installarle. + +``` +Dai esempi +``` + +### Installazione + +Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo. + +Indica qual è il passo + +``` +Dai l'esempio +``` + +E ripeti + +``` +Fino alla fine +``` + +Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo. + +## 🚀 Deployare il tuo bot + +Per vedere un esempio di progetto su come deployare il tuo bot, vedi la mia configurazione: + +- **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot + +## ⛏️ Costruito con + +- [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper +- [Heroku](https://www.heroku.com/) - SaaS hosting platform + +## ✍️ Autori + +- [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare + +Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors) +che hanno partecipato a questo progetto. + +## 🎉 Riconoscimenti + +- Cenno a tutti quelli il cui codice è stato utilizzato +- Ispirazione +- Riferimenti diff --git a/it/README_TEMPLATES/Hackathon.md b/it/README_TEMPLATES/Hackathon.md index e69de29..cff83fc 100644 --- a/it/README_TEMPLATES/Hackathon.md +++ b/it/README_TEMPLATES/Hackathon.md @@ -0,0 +1,116 @@ +

+ + Project logo +

+

Titolo del Progetto

+ +
+ +[![Hackathon](https://img.shields.io/badge/hackathon-name-orange.svg)](http://hackathon.url.com) +[![Status](https://img.shields.io/badge/status-active-success.svg)]() +[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) + +
+ +--- + +

Poche righe di descrizione del tuo progetto. +
+

+ +## 📝 Indice + +- [Testo del Problema](#problem_statement) +- [Idea / Soluzione](#idea) +- [Dipendenze / Limitazioni](#limitations) +- [Scopo Futuro](#future_scope) +- [Impostare un ambiente locale](#getting_started) +- [Utilizzo](#usage) +- [Tecnologie Utilizzate](#tech_stack) +- [Contribuire](../CONTRIBUTING.md) +- [Autori](#authors) +- [Riconoscimenti](#acknowledgments) + +## 🧐 Testo del Problema + +È utile progettare e seguire un format specifico quando si scrive il testo di un problema. Sebbene ci siano diverse opzioni per far ciò, quanto segue è un semplice e diretto modello spesso usato in Analisi Aziendale per mantenere il focus sulla definizione del problema. + +- IDEALE: Questa sezione è utilizzata per descrivere lo stato finale del processo o prodotto. Alla larga, questa sezione + dovrebbe illustrare come l'ambiente si presenterà una volta implementata la soluzione. +- REALTÀ: Questa sezione serve a descrivere lo stato corrente del processo o prodotto. +- CONSEGUENZE: Questa sezione è utilizzata per descrivere le conseguenze sull'azienda se il problema non è risolto o migliorato. + Questo include costi associati con la perdita di soldi, tempo, produttività, vantaggi competitivi, e così via. + +Seguire questo format risulterà in un documento che può essere utilizzato per capire il problema e suscitare requisiti che porteranno ad una soluzione vincente. + +## 💡 Idea / Soluzione + +Questa sezione è utilizzata per descrivere potenziali soluzioni. + +Una volta che le sezioni ideale, realtà e conseguenze sono state completate, e capite, diventa facile fornire una soluzione al problema. + +## ⛓️ Dipendenze / Limitazioni + +- Quali sono le dipendenze del tuo progetto? +- Descrivi ogni limitazione in termini dettagliati ma concisi +- Spiega il motivo dell'esistenza di ogni limitazione +- Fornisci le ragioni per cui ogni limitazione non poteva essere superata con il metodo scelto. +- Valuta l'impatto di ogni limitazione in relazione ai ritrovamenti e conclusioni del tuo progetto, e se adeguato, descrivi come queste limitazioni potrebbero indicare al bisogno di ricerche ulteriori. + +## 🚀 Scopo Futuro + +Scrivi riguardo a ciò che non sei riuscito a sviluppare durante il corso della Hackathon; e riguardo a quello che il tuo progetto può ottenere in futuro. + +## 🏁 Come Iniziare + +Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto. + +### Prerequisiti + +Di cosa hai bisogno per installare il software e come installarle. + +``` +Dai esempi +``` + +### Installazione + +Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo. + +Indica qual è il passo + +``` +Dai l'esempio +``` + +E ripeti + +``` +Fino alla fine +``` + +## 🎈 Utilizzo + +Aggiungi note su come usare il sistema. + +## ⛏️ Costruito con + +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment + +## ✍️ Autori + +- [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare + +Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors) +che hanno partecipato a questo progetto. + +## 🎉 Riconoscimenti + +- Cenno a tutti quelli il cui codice è stato utilizzato +- Ispirazione +- Riferimenti diff --git a/it/README_TEMPLATES/Minimal.md b/it/README_TEMPLATES/Minimal.md index e69de29..06f1059 100644 --- a/it/README_TEMPLATES/Minimal.md +++ b/it/README_TEMPLATES/Minimal.md @@ -0,0 +1,46 @@ +# Titolo del Progetto + +## Indice + +- [Descrizione](#about) +- [Come Iniziare](#getting_started) +- [Utilizzo](#usage) +- [Contributing](../CONTRIBUTING.md) + +## Descrizione + +Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto. + +## Come Iniziare + +Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto. + +### Prerequisiti + +Di cosa hai bisogno per installare il software e come installarle. + +``` +Dai esempi +``` + +### Installazione + +Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo. + +Indica qual è il passo + +``` +Dai l'esempio +``` + +E ripeti + +``` +Fino alla fine +``` + +Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo. + +## Utilizzo + +Aggiungi note su come usare il sistema. diff --git a/it/README_TEMPLATES/README.md b/it/README_TEMPLATES/README.md index 414d525..99bff8d 100644 --- a/it/README_TEMPLATES/README.md +++ b/it/README_TEMPLATES/README.md @@ -1,7 +1,7 @@ -### This folder contains various README Templates that one can use based on the type of project. +### Questa cartella contiene vari modelli di README che si possono usare in base al tipo di progetto. -1. [Bot.md](/README%20Templates/Bot.md) - -2. [Hackathon.md](/README%20Templates/Hackathon.md) - -3. [IoT.md](/README%20Templates/IoT.md) - -4. [Minimal.md](/README%20Templates/Minimal.md) - -5. [Standard.md](/README%20Templates/Standard.md) - +1. [Bot.md](/README%20Templates/Bot.md) - +2. [Hackathon.md](/README%20Templates/Hackathon.md) - +3. [IoT.md](/README%20Templates/IoT.md) - +4. [Minimal.md](/README%20Templates/Minimal.md) - +5. [Standard.md](/README%20Templates/Standard.md) - diff --git a/it/README_TEMPLATES/Standard.md b/it/README_TEMPLATES/Standard.md index e69de29..6e98a46 100644 --- a/it/README_TEMPLATES/Standard.md +++ b/it/README_TEMPLATES/Standard.md @@ -0,0 +1,115 @@ +

+ + Project logo +

+ +

Titolo del Progetto

+ +
+ +[![Status](https://img.shields.io/badge/status-active-success.svg)]() +[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/kylelobo/The-Documentation-Compendium/pulls) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE) + +
+ +--- + +

Poche righe di descrizione del tuo progetto. +
+

+ +## 📝 Table of Contents + +- [Descrizione](#about) +- [Come Iniziare](#getting_started) +- [Distribuzione](#deployment) +- [Utilizzo](#usage) +- [Costruito Con](#built_using) +- [TODO](../TODO.md) +- [Contribuire](../CONTRIBUTING.md) +- [Autori](#authors) +- [Riconoscimenti](#acknowledgement) + +## 🧐 Descrizione + +Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto. + +## 🏁 Come Iniziare + +Queste istruzioni ti daranno una copia del progetto funzionante sul tuo computer locale per scopi di sviluppo e testing. Vedi [deployment](#deployment) per istruzioni su come deployare il progetto. + +### Prerequisiti + +Di cosa hai bisogno per installare il software e come installarle. + +``` +Dai esempi +``` + +### Installazione + +Una serie di esempi passo a passo che ti dicono come avviare un ambiente di sviluppo. + +Indica qual è il passo + +``` +Dai l'esempio +``` + +E ripeti + +``` +Fino alla fine +``` + +Chiudi con un esempio su come ottenere dei dati dal sistema o su come usarlo per una piccola demo. + +## 🔧 Eseguire i test + +Spiega come eseguire i test automatici per questo sistema. + +### Scomponi in test end to end + +Spiega cosa e perchè testano questi test + +``` +Dai un esempio +``` + +### E test sullo stile del codice + +Spiega cosa e perchè testano questi test + +``` +Dai un esempio +``` + +## 🚀 Distribuzione + +Aggiungi appunti su come deployare questo progetto su un sistema live. + +## 🎈 Utilizzo + +Aggiungi note su come usare il sistema. + +## ⛏️ Costruito con + +- [MongoDB](https://www.mongodb.com/) - Database +- [Express](https://expressjs.com/) - Server Framework +- [VueJs](https://vuejs.org/) - Web Framework +- [NodeJs](https://nodejs.org/en/) - Server Environment + +## ✍️ Autori + +- [@kylelobo](https://github.com/kylelobo) - Idea & Lavoro iniziare + +Vedi anche la lista di [contributori](https://github.com/kylelobo/The-Documentation-Compendium/contributors) +che hanno partecipato a questo progetto. + +## 🎉 Riconoscimenti + +- Cenno a tutti quelli il cui codice è stato utilizzato +- Ispirazione +- Riferimenti