Como deixar o README.md em Múltiplas Línguas

Na criação do meu primeiro projeto para o Github, foi me introduzido o conceito do README.md, um importante arquivo que serve para ilustrar e descrever todo o seu projeto no Github. Na produção desse documento, surgiu a dúvida de como deixá-lo em diferentes línguas, já que esses projetos podem facilmente ser vistos por usuários de todo o globo. Nesse artigo, entenda como deixar a descrição dos seus projetos em diferentes línguas e como isso é importante para tornar os seus trabalhos mais acessíveis.

1. Criação de Arquivos README Separados

A maneira mais simples e direta de oferecer suporte a múltiplas línguas é criar versões separadas do README.md para cada idioma. Cada arquivo pode ser nomeado conforme a convenção README.lang.md, onde lang representa o código de idioma, como en para inglês, pt para português, es para espanhol, e assim por diante. Por exemplo:

• README.md (padrão)
• README.pt.md (português)
• README.es.md (espanhol)

No README principal (geralmente em inglês), você pode fornecer links para as versões traduzidas:

# README em diferentes idiomas
- [English](README.md)
- [Português](README.pt.md)
- [Español](README.es.md)

2. Seções Multi-Idiomas no Mesmo Arquivo README

Outra abordagem é manter todas as traduções em um único arquivo README.md. Você pode organizar o conteúdo em seções, cada uma dedicada a um idioma específico. Isso é útil para projetos menores ou quando as traduções não são extensas.

# Projeto Nome


## English
[English version of the README content]


## Português
[Versão em português do conteúdo do README]


## Español
[Versión en español del contenido del README]

3. Uso de GitHub Actions para Alternar Idiomas

Para um nível mais avançado, você pode utilizar GitHub Actions ou outros scripts automatizados para detectar o idioma preferido do visitante e exibir automaticamente o README no idioma correspondente. Isso requer a criação de um script que atualize o README.md principal com base no idioma selecionado, embora seja uma opção mais complexa e menos comum.

4. Internacionalização (i18n) com Ferramentas Externas

Existem também ferramentas de i18n que ajudam a gerenciar e automatizar traduções de arquivos de documentação, incluindo README.md. Essas ferramentas podem ser integradas ao seu fluxo de trabalho para simplificar a manutenção de múltiplas versões de README em diferentes idiomas.

Conclusão

Oferecer suporte a múltiplos idiomas no seu README.md é um investimento que pode tornar seu projeto mais inclusivo e acessível. Escolha a abordagem que melhor se adapta ao tamanho e às necessidades do seu projeto, garantindo que usuários de diferentes regiões possam interagir com ele de forma eficaz.