1
0
mirror of https://github.com/kylelobo/The-Documentation-Compendium.git synced 2025-09-02 09:33:06 +02:00

Merge pull request #36 from albertomosconi/italian

Italian Translation for README Templates
This commit is contained in:
Kyle Lobo
2020-09-06 23:29:32 +05:30
committed by GitHub
5 changed files with 426 additions and 6 deletions

View File

@@ -0,0 +1,143 @@
<p align="center">
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/FxL5qM0.jpg" alt="Bot logo"></a>
</p>
<h3 align="center">Nome del Bot</h3>
<div align="center">
[![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)
</div>
---
<p align="center"> 🤖 Qualche riga per descrivere le funzionalità del tuo bot.
<br>
</p>
## 📝 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 <a name = "about"></a>
Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo bot.
## 🎥 Demo / Funzionamento <a name = "demo"></a>
![Funzionamento](https://media.giphy.com/media/20NLMBm0BkUOwNljwv/giphy.gif)
## 💭 Come Funziona <a name = "working"></a>
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 <a name = "usage"></a>
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
---
<sup>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)</sup>
<sup>Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)</sup>
## 🏁 Come Iniziare <a name = "getting_started"></a>
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 <a name = "deployment"></a>
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 <a name = "tech_stack"></a>
- [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
- [Heroku](https://www.heroku.com/) - SaaS hosting platform
## ✍️ Autori <a name = "authors"></a>
- [@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 <a name = "acknowledgments"></a>
- Cenno a tutti quelli il cui codice è stato utilizzato
- Ispirazione
- Riferimenti

View File

@@ -0,0 +1,116 @@
<p align="center">
<a href="" rel="noopener">
<img src="https://i.imgur.com/AZ2iWek.png" alt="Project logo"></a>
</p>
<h3 align="center">Titolo del Progetto</h3>
<div align="center">
[![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)
</div>
---
<p align="center"> Poche righe di descrizione del tuo progetto.
<br>
</p>
## 📝 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 <a name = "problem_statement"></a>
È 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 <a name = "idea"></a>
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 <a name = "limitations"></a>
- 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 <a name = "future_scope"></a>
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 <a name = "getting_started"></a>
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 <a name="usage"></a>
Aggiungi note su come usare il sistema.
## ⛏️ Costruito con <a name = "tech_stack"></a>
- [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 <a name = "authors"></a>
- [@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 <a name = "acknowledgments"></a>
- Cenno a tutti quelli il cui codice è stato utilizzato
- Ispirazione
- Riferimenti

View File

@@ -0,0 +1,46 @@
# Titolo del Progetto
## Indice
- [Descrizione](#about)
- [Come Iniziare](#getting_started)
- [Utilizzo](#usage)
- [Contributing](../CONTRIBUTING.md)
## Descrizione <a name = "about"></a>
Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
## Come Iniziare <a name = "getting_started"></a>
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 <a name = "usage"></a>
Aggiungi note su come usare il sistema.

View File

@@ -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) -

View File

@@ -0,0 +1,115 @@
<p align="center">
<a href="" rel="noopener">
<img width=200px height=200px src="https://i.imgur.com/6wj0hh6.jpg" alt="Project logo"></a>
</p>
<h3 align="center">Titolo del Progetto</h3>
<div align="center">
[![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)
</div>
---
<p align="center"> Poche righe di descrizione del tuo progetto.
<br>
</p>
## 📝 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 <a name = "about"></a>
Scrivi circa 1-2 paragrafi descrivendo lo scopo del tuo progetto.
## 🏁 Come Iniziare <a name = "getting_started"></a>
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 <a name = "tests"></a>
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 <a name = "deployment"></a>
Aggiungi appunti su come deployare questo progetto su un sistema live.
## 🎈 Utilizzo <a name="usage"></a>
Aggiungi note su come usare il sistema.
## ⛏️ Costruito con <a name = "tech_stack"></a>
- [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 <a name = "authors"></a>
- [@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 <a name = "acknowledgments"></a>
- Cenno a tutti quelli il cui codice è stato utilizzato
- Ispirazione
- Riferimenti